Requirements

1. Python ^3.11

2. Poetry

3. Docker

Start Project

Clone the repository

git clone

Enter into project folder

cd folder

There is no sensitive information in .env(like tokens, emails, etc.), so you can edit it as you wish

Run project

docker-compose up --build

Test your API

After starting the project, go to http://localhost:8080/docs
There you see all avaliable endpoints, click "Try it out", and now you can make request to them.

Technology that i used

1. Project manager Poetry

2. Cache Redis

3. Dockerize all with Docker

4. Framework FastAPI

5. Database async sessions with SqlAlchemy

6. Migrations with Alembic

TODO

• Add type hints

• Rewrite Dockerfile

• Add Celery for scheduale tasks (like delete referal code after expiration ends, etc.)

• Add Pre-commit hooks for linting project

• Add Makefile for project

• Clean project