QRKot Charity Fund🐈🐱

Project Description

QRKot_spreadsheets is an API application designed for creating charity projects and organizing donations for cats.

The fund collects donations for various targeted initiatives: medical care for cats in need, setting up cat colonies in basements, providing food for abandoned cats — any cause related to supporting the feline population. A report on closed projects, sorted by the speed of fundraising, is automatically generated in a Google spreadsheet.

Installation and Setup

1. Clone the repository:

   git clone git@github.com:closecodex/QRkot_spreadsheets.git
   cd QRkot_spreadsheets

2. Create and activate a virtual environment:

   python -m venv venv
   source venv\Scripts\activate

3. Upgrade pip and install dependencies:

   python -m pip install --upgrade pip
   pip install -r requirements.txt

4. Run database migrations:

   alembic upgrade head

5. Start the application:

   uvicorn app.main:app --reload

Example Endpoints

Authentication

• POST /auth/register — Register a new user.

• POST /auth/jwt/login — Log in and obtain a JWT token.

Charity Projects

• GET /charity_project/ — Retrieve a list of all charity projects.

• POST /charity_project/ — Create a new charity project.

Donations

• GET /donation/my — Get a list of your personal donations.

• POST /donation/ — Make a new donation.

Additional Information

1. Author: (Mariia Osmolovskaia)

2. Technologies: Python, FastAPI, SQLAlchemy, Alembic, SQLite, Pydantic

3. API Documentation: Swagger UI, ReDoc