docker compose up -dThis project uses a package and dependency maganer called uv. Installation guide
1º step: uv installation
curl -LsSf https://astral.sh/uv/install.sh | sh
2º step: Creating virtual enviroment and activating
uv venvsource .venv/bin/activateNote:
On Linux and macOS, the commands to install and activate the virtual environment are the same. For Windows, please refer to the official documentation.
3º step: install all dependencies
uv sync --all-groupsWarning:
Please remember to configure the
.envfile. .env example file
Database Diagram
uv run main.py update-role <user_id> <role(admin|dev|user)>This command updates a user's role from the CLI. Updating a role via the API is only allowed if your role is admin.
uv run main.py run --host=<(optional|default=127.0.0.1)> --port=<(optional|default=8000)>
This command starts the API.
- asyncpg >=0.30.0
- email-validator >=2.2.0
- faker >=36.1.1
- fastapi >=0.115.8
- fastapi-pagination >=0.13.0
- httpx >=0.28.1
- passlib[bcrypt] >=1.7.4
- pre-commit >=4.1.0
- pydantic >=2.10.6
- pydantic-settings >=2.7.1
- pytest >=8.3.4
- pytest-asyncio >=0.25.3
- pytest-dotenv >=0.5.2
- python-jose >=3.5.0
- python-multipart >=0.0.20
- redis >=5.2.1
- sqlalchemy[mypy] >=2.0.38
- typer >=0.16.0
- uvicorn[standard] >=0.34.3