This project is a backend for a charity fund written in Python using the FastAPI framework. It provides an API for managing users, maintaining charity projects and donations. It's mostly the same as charity fund project but adds an endpoint to create a report in google sheets using google API.
- Clone the repository
git clone https://github.com/alisher-nil/cat_charity_fund.git- Navigate to the project directory:
cd cat_charity_fund- Create a virtual environment:
python3 -m venv venv- Activate the virtual environment:
-
Linux/macOS
source venv/bin/activate -
Windows
source venv/scripts/activate
- Upgrade PIP and install required dependencies:
python3 -m pip install --upgrade pip
pip install -r requirements.txt- Adjust environment variables in
.envfile.
Example provided in .env.example
To run the project use the following command from the project's root directory:
uvicorn app.main:app --reloadBy default the project will be available at localhost:8000/
API documentation can be found at localhost:8000/docs/ for Swagger and localhost:8000/redoc/ for Redoc.
Users are implemented with bearer transport and JWT strategy.
Please feel free to contact me with any questions or feedback:
- Email: alisher.nil@gmail.com
- GitHub: alisher-nil