TrackIt API

API for tracking habits. Written in FastAPI with asynchronous database operations. REST-like approach.

Installation and launch (Ubuntu)

git clone https://github.com/ghostfaccee/TrackIt-API.git
cd TrackIt-API
docker compose up --build -d

Applying new migrations

docker compose exec api alembic upgrade head

Documentation

You can view the documentation at http://127.0.0.1:8000/docs when the container is running

Stop container

docker compose down

Change in the project (for developers)

If you decide to add changes to the tables yourself or add new ones, create your own migration using alembic inside the docker container

docker compose exec api alembic revision --autogenerate -m "describe your changes"
docker compose exec api alembic upgrade head

You can view the environment variables in the .env.example file.

To get logs in file format, use:

docker compose logs > logs.txt

License

MIT. You can find it in the root of the project.