- ⚡ FastAPI for the Python backend API.
- 🧰 SQLModel for the Python SQL database interactions (ORM).
- 🔍 Pydantic, used by FastAPI, for the data validation and settings management.
- 💾 PostgreSQL as the SQL database.
- 🐋 Docker Compose for development and production.
- ✅ Tests with Pytest.
- 🚢 Deployment instructions using Docker Compose
- 🏭 CI/CD based on GitHub Actions.
To use this project, you need to clone it and launch it.
Follow the next steps:
- Clone this repository:
git clone [email protected]:thyb-zytek/budgly-api.git
- Enter into the new directory:
cd budgly-api
- Create .env file from .env.sample and change values with your own:
mv .env.sample .env
- Launch your stack:
docker compose up -d
- Verify API server is up, if it displays
OK
, it means that the server is up:
curl -X 'GET' 'http://localhost:8000/healthcheck' -H 'accept: application/json'
Now you can use the APIs.
🌐 Interactive Docs (Swagger UI): http://localhost:8000/docs
🌐 Alternative Docs (ReDoc): http://localhost:8000/redoc
🌐 APIs: http://localhost:8000/api/v1/
The Budgly project is licensed under the terms of the GPL-3.0 license.