Taskboard API

Taskboard API is a RESTful-service for task management. It supports account management (sign up, auth); tasks management (create, edit, remove, find, sort). Easily runnable via Docker.

Quick start

1. Make sure you have Docker installed.
2. Clone repository

git clone https://github.com/byhexdev/taskboard.git
cd taskboard

3. Rename .env-example to .env.
4. Edit your new .env file:
   1. (Optional) POSTGRES_USER – your database username.
   2. POSTGRES_PASSWORD – your database password.
   3. SECRET_KEY – your secret key, required to generate safe user authorization tokens.
   4. (Optional) ACCESS_TOKEN_EXPIRE_MINUTES, REFRESH_TOKEN_EXPIRE_HOURS – the amount of time before token becomes invalid.
5. Run docker compose

docker compose up -d --build

6. Done! The API should now be running at http://127.0.0.1:8000/api/v1.

Docs are available at http://127.0.0.1:8000/docs.

Tests

All the tests are written on pytest (using unittest mocks). Tests can be run via docker compose run --rm app pytest -v / pytest -v (requires local installation).