Благотоворительные сборы

Сервис позволяет создавать и управлять благотворительными проектами.

Установка

1. Склонируйте репозиторий:

   git clone https://github.com/Toksi86/Charity_fund.git

2. Перейдите в каталог проекта

   cd cat_charity_fund/

3. Создайте виртуальную среду окружения

   python -m venv .venv

4. Активируйте вирутальную среду окружения

   source .venv/Scripts/activate

5. Установите зависимости:

   pip install -r requirements.txt

6. Настройте переменные окружения

   • Создайте файл .env в корне проекта

     touch .env

   • Заполнить .env файл по примеру

     APP_TITLE=Заголовок вашего приложения
     DATABASE_URL=ваша_ссылка_на_базу_данных
     SECRET=ваш_секретный_ключ
     FIRST_SUPERUSER_EMAIL=почта_администратора
     FIRST_SUPERUSER_PASSWORD=пароль_администратора
     
     TYPE=Тип_сервисного_аккаунта
     PROJECT_ID=Идентификатор_проекта_Google_Cloud_Platform
     PRIVATE_KEY_ID=Идентификатор_закрытого_ключа_сервисного_аккаунта
     PRIVATE_KEY=Закрытый_ключ_сервисного_аккаунта
     CLIENT_EMAIL=Электронная_почта_сервисного_аккаунта
     CLIENT_ID=Идентификатор_клиента_сервисного_аккаунта
     AUTH_URI=URI_для_аутентификации
     TOKEN_URI=URI_для_получения_токена_доступа
     AUTH_PROVIDER_X509_CERT_URL=URL_сертификата_поставщика_аутентификации
     CLIENT_X509_CERT_URL=URL_сертификата_сервисного_аккаунта
     EMAIL=Электронная_почта_которая_будет_использоваться_для_отправки_уведомлений_и_доступа_к_таблицам
     

7. Инициализируйте базу данных

   alembic.exe upgrade head

8. Запустите приложение:

   uvicorn app.main:app
   

Автор

Автор проекта - Шперлинг Константин.

Стек технологий

Проект реализован с использованием следующих технологий:

• Python
• FastAPI
• SQLAlchemy
• SQLite
• Alembic
• Pydantic
• FastAPI Users
• PyJWT
• OAuth2
• Swagger UI
• ReDoc
• Postman
• Google Driver API
• Google Sheets API

Доступ к справке

Доступ к справке предоставляется через ReDoc и Swagger UI.

ReDoc: http://127.0.0.1:8000/redoc

Swagger UI: http://127.0.0.1:8000/docs

Контакты

Если у вас есть вопросы или предложения, пожалуйста, свяжитесь со мной:

• Telegram: @Toksi86