RKeeper

Описание

Приложение для хранения рецептов

Стек используемых технологий

1. Python
2. FastAPI, alembic
3. PostgreSQL, SQLAlchemy
4. MongoDB

API

Чтобы открыть swagger с описанием endpoint'ов, запустите проект. По умолчанию он запускается на 0.0.0.0:8000. Всю информацию по API можно посмотреть на вкладке /docs

Установка

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

   git clone https://github.com/MikhailShurov/RKeeper.git
   

2. Установите зависимости командой:

   pip install -r requirements.txt
   

3. Переименуйте файл .env_ex в .env и добавьте свои данные для работы приложения
4. Запустите файл main.py
5. Если вы не хотите перезапускать код каждый раз, откройте директорию проекта в терминале:

   Linux:
   cd ~/PycharmProjects/RKeeper
   

   Запустите скрипт командой:

   uvicorn src.main:app --host 0.0.0.0 --port 8000 --reload
   

   Теперь проект будет автоматически перезапускаться при внесении изменений в код
6. Чтобы запустить сборку и запуск через docker, выполните в терминале команду:

   docker compose up --build
   

   Чтобы запускать без сборки, используйте:

   docker compose up
   

   Чтобы только собрать проект, используйте:

   docker compose build
   

Разработка

1. Если вы собираетесь добавить новый функционал, создайте у себя ветку <название фичи> командой:

   git checkout -b <название фичи>
   

2. Разрабатывайте функциоал
3. Создавайте pull request из своей ветки в ветку develop этого репозитория

Структура проекта и внесение изменений

1. Ветка master -- продакшн ветка. Здесь лежит продакш код, который надо беречь как зеницу ока
2. Ветка testing -- вторая по значимости ветка. Отсюда код после тестирования отправляется в master
3. Ветка develop -- сюда принимаются пулл реквесты с новым функционалом. После первичного тестирования в develop код попадает в testing