humblFINANCE Backend is a FastAPI-based backend service for the humblFINANCE web app. It provides the necessary API endpoints and data processing capabilities to support the financial operations of the humblFINANCE platform.
- 🐍 Python 3.11
- 🚀 FastAPI
- 🗃️ SQLModel (ORM)
- 🔄 Alembic (Database migrations)
- 📊 humbldata (Custom data library)
- 🏗️ Poetry (Dependency management)
- 🐳 Docker (Containerization)
- RESTful API endpoints for financial data
- Database integration with SQLModel
- Asynchronous operations support
- Configurable settings for different environments
- Clone the repository
git clone https://github.com/humblfinance/humblfinance-backend.git - Install dependencies:
poetry install - Set up your environment variables
cp .env.example .env - Build and run the Docker container:
docker build -t humblfinance-api . docker run -p 8080:8080 humblfinance-api - Alternatively, run the application directly:
uvicorn backend.main:app --host 0.0.0.0 --port 8080 ## OR ## fastapi run backend/main.py --host 0.0.0.0 --port 8080
The application can be containerized using Docker. Build and run the Docker image using the provided Dockerfile.
- Linting: Ruff
- Type checking: MyPy
- Documentation: MkDocs
The FastAPI app uses fastapi-cache2 for caching. This stores cached values in a local redis DB when in development mode, and in a remote redis DB when in production mode (vercel kv). Please make sure that your local redis DB is running, or that the remote redis DB is available, before running the app.
For more detailed information, refer to the MkDocs-generated documentation.
- jjfantini [email protected]
Attribution-NonCommercial-ShareAlike 4.0 International