aahnik / fastapi-url-shortener

Simple yet powerful URL shortener built with FastAPI. Work is in Progress. No external issues or PRs will be accepted.

fastapi-url-shortener

Simple yet powerful URL shortener built with FastAPI.

Work is in Progress. No external issues or PRs will be accepted.

• fastapi-url-shortener
  • Features
  • Docs
  • How to deploy
    • Deploy to Heroku
    • Run on Localhost

Features

• Fast and scalable
• Shorten a long URL using a custom slug
• Self host easily
• Connect to your own domain
• Integrate with other services using RESTful API
• Free and Open Source

Docs

• Swagger
• Redoc

How to deploy

You are expected to have git installed in your system.

First of all clone the repository and move into the directory.

git clone https://github.com/aahnik/fastapi-url-shortener
cd fastapi-url-shortener

Deploy to Heroku

Make sure you have Heroku CLI installed.

• Create a new Heroku app

  heroku create

• Push the code to Heroku

  git push heroku main

Run on Localhost

• Install dependancies from requirements.txt

  pip install -r requirements.txt

• Run the server using uvicorn

  uvicorn main:app --reload