Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladislavyar/qrkot_spreadsheets
https://github.com/vladislavyar/qrkot_spreadsheets
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vladislavyar/qrkot_spreadsheets
- Owner: VladislavYar
- Created: 2023-10-29T20:32:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-28T16:41:13.000Z (11 months ago)
- Last Synced: 2023-12-28T17:45:03.922Z (11 months ago)
- Language: Python
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# QRkot_spreadsheets
## приложение для Благотворительного фонда поддержки котиков QRKot
Проект представляет из себя API, сделанный на фреймворке FastAPI.
## Как запустить проект:
### Клонировать репозиторий и перейти в него в командной строке:
```
git clone [email protected]:VladislavYar/cat_charity_fund.git
```
### Создать и активировать виртуальное окружение:
```
python -m venv env
source env/scripts/activate
```
### Установить зависимости из файла requirements.txt:
```
pip install -r requirements.txt
```
## Запуск приложение
```
uvicorn app.main:app
```
## Cтек проекта
Python v3.9, FastAPI, SQLAlchemy, Google API
## Ручки:
### Auth
```
POST
/auth/jwt/login - аутентификация
POST
/auth/jwt/logout - выход
POST
/auth/register - регистрация
```
### Users
```
GET
/users/me - получить данные свого профиля
PATCH
/users/me - обновить данные своей профиля
GET
/users/{id} - получить данные другого пользователя
```
### Donation
```
GET
/donation/ - получить все пожертвования
POST
/donation/ - создать пожертвование
GET
/donation/my - получить личные пожертвования
```
### Charity Project
```
GET
/charity_project/ - получить все проекты
POST
/charity_project/ - создать проект
DELETE
/charity_project/{project_id} - удалить проект
PATCH
/charity_project/{project_id} - обновить данные по проекту
```
### Google
```
POST
/google/ - cоздать отчёт в Google-таблице с закрытми проектами отсортированными по времени сбора пожертвований.