Skip to content

Shortify is a URL shortener RESTful API built with Python and FastAPI ⚡

License

Notifications You must be signed in to change notification settings

IHosseini083/Shortify

Repository files navigation

Shortify is a fast, fully async and reliable URL shortener RESTful API built with Python and FastAPI framework. It uses the open source MongoDB database for storing shortened URLs data and implements user registration via OAuth2 JWT authentication.

Features

  • Fully async and non-blocking.
  • Uses FastAPI framework for API development:
  • Uses MongoDB as data store for users and shortened URLs.
  • Extensible architecture for adding new API endpoints and services.
  • Descriptive and well-documented code.
  • OAuth2 (with hashed passwords and JWT tokens) based user authentication.
  • Uses Poetry for dependency management.
  • Automated code formatting and linting with pre-commit and black.
  • CORS (Cross Origin Resource Sharing) support.

Requirements

Setup

Documentation and Usage

License

This project is licensed under the terms of the GPL-3.0 license.

— ⚡ —