- Python 3.12+
- PostgreSQL 16
- Docker & Docker Compose (optional)
1. Clone and set up environment
cp .env.example .env
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt2. Start the database
docker compose up db -d3. Run migrations
alembic upgrade head4. Start the server
uvicorn app.main:app --reloadAPI docs available at http://localhost:8000/docs
docker compose up --build| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/v1/auth/register |
— | Register |
| POST | /api/v1/auth/login |
— | Login |
| POST | /api/v1/auth/refresh |
— | Refresh tokens |
| POST | /api/v1/auth/logout |
JWT | Logout |
| GET | /api/v1/users/me |
JWT | Get current user |
| PATCH | /api/v1/users/me |
JWT | Update current user |
| DELETE | /api/v1/users/me |
JWT | Delete account |
| GET | /api/v1/users/me/profile |
JWT | Get profile |
| PATCH | /api/v1/users/me/profile |
JWT | Update profile |
| GET | /health |
— | Health check |