torhamdev / link-shortener-fastapi

a simple link shortener with FastAPI

Link shortener with FastAPI

a simple link shortener with FastAPI

My practice for using FastAPI. In this exercise, a link shortening system is built and it is tried to be optimized as much as possible.

Technologies such as Docker and Redis are also used in this exercise.

Technologies used:

How to Run?

You can run this project in three ways. manually, using docker-compose and using Docker

Manually

# clone the project
git clone https://github.com/TorhamDev/link-Shortener-FastAPI.git

cd link-Shortener-FastAPI

# install libs
pip install -r requirements.txt

# run the projct
uvicorn main:app --host 0.0.0.0 --port 8080

Using docker-compose

# clone the project
git clone https://github.com/TorhamDev/link-Shortener-FastAPI.git

cd link-Shortener-FastAPI

# Run and build project
docker-compose up --build  -d

Using docker

# clone the project
git clone https://github.com/TorhamDev/link-Shortener-FastAPI.git

cd link-Shortener-FastAPI

# building docker image
docker build -t fast-api-link .

# run the project on 8080 port
docker run -d -p 8080:8080 fast-api-link

admin panel

Too see admin panel after running, go to the /admin/

Document

To see the project document, after running it, go to the /redoc or /docs path and view the document

License