Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aahnik/fastapi-url-shortener
Simple yet powerful URL shortener built with FastAPI. Work is in Progress. No external issues or PRs will be accepted.
https://github.com/aahnik/fastapi-url-shortener
analytics async fastapi python python3 url-shortener web
Last synced: about 1 month ago
JSON representation
Simple yet powerful URL shortener built with FastAPI. Work is in Progress. No external issues or PRs will be accepted.
- Host: GitHub
- URL: https://github.com/aahnik/fastapi-url-shortener
- Owner: aahnik
- License: mit
- Created: 2021-02-24T06:37:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-29T06:54:03.000Z (almost 2 years ago)
- Last Synced: 2024-05-08T00:31:56.776Z (7 months ago)
- Topics: analytics, async, fastapi, python, python3, url-shortener, web
- Language: Python
- Homepage: https://fastapi-url-shortener.herokuapp.com
- Size: 29.3 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fastapi-url-shortener
Simple yet powerful URL shortener built with [FastAPI](https://github.com/tiangolo/fastapi).
**Work is in Progress. No external issues or PRs will be accepted.**
- [fastapi-url-shortener](#fastapi-url-shortener)
- [Features](#features)
- [Docs](#docs)
- [How to deploy](#how-to-deploy)
- [Deploy to Heroku](#deploy-to-heroku)
- [Run on Localhost](#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](https://fastapi-url-shortener.herokuapp.com/docs)
- [Redoc](https://fastapi-url-shortener.herokuapp.com/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.
```shell
git clone https://github.com/aahnik/fastapi-url-shortener
cd fastapi-url-shortener
```
### Deploy to Heroku
Make sure you have [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed.
- Create a new Heroku app
```shell
heroku create
```
- Push the code to Heroku
```shell
git push heroku main
```
### Run on Localhost
- Install dependancies from [`requirements.txt`](requirements.txt)
```shell
pip install -r requirements.txt
```
- Run the server using [`uvicorn`](https://github.com/encode/uvicorn)
```shell
uvicorn main:app --reload
```