https://github.com/shasoka/needforfit_backend

Веб фитнес-трекер "Надо подкачаться". Командный проект. КИ21-16/2Б. Мочалов Семен, Шенберг Аркадий, Бокаленко Илья.
https://github.com/shasoka/needforfit_backend

Last synced: about 2 months ago
JSON representation

Веб фитнес-трекер "Надо подкачаться". Командный проект. КИ21-16/2Б. Мочалов Семен, Шенберг Аркадий, Бокаленко Илья.

• Host: GitHub
• URL: https://github.com/shasoka/needforfit_backend
• Owner: shasoka
• Created: 2023-11-10T09:55:35.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-29T09:14:45.000Z (7 months ago)
• Last Synced: 2024-05-29T21:50:18.001Z (7 months ago)
• Language: Python
• Homepage:
• Size: 1.08 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Инструкция по развертыванию приложения

### Требования для запуска

1. PostgreSQL >= 15.5

2. Python >= 3.11

### Подготовительный этап

Все описанные ниже операции производятся в терминале из корня проекта.

1. Разворачиваем БД. Для этого **(лучше) из CMD**:

   ```

   SET PGCLIENTENCODING=utf-8

   chcp 65001

   psql -U postgres -h localhost -f .\migrations\migrate.sql -f .\migrations\seed.sql

   ```

   Скрипт ```migrate.sql``` создает БД с именем nff и девятью таблицами. 

   Скрипт ```seed.sql``` заполняет таблицы пресетами. Для доступа к приложению создается один пользователь: `admin`:`admin`

2. Создаем файл с именем ```.env```. Его содержимое должно иметь следующую структуру:

   ```

   DB_HOST=

   DB_PORT=

   DB_NAME=nff

   DB_USER=

   DB_PASS=

   JWT_SECRET=

   JWT_ALG=HS256

   TOKEN_EXPIRATION=

   SERVER_HOST=localhost

   SERVER_PORT=8000

   ```

   По дефолту хостом является `localhost`, а портами - `5432`(для БД) и `8000`(для сервера) (смотрите ```example.env```). Хэш можно получить где-то здесь: https://emn178.github.io/online-tools/sha256.html.

3. Создаем виртуальное окружение и активируем его:

   ```

   python -m venv venv

   .\venv\Scripts\activate

   ```

   Самый важный пункт! Обязательно активируйте виртуальное окружение, чтобы иметь доступ к модулю, ответственному за сервер.

4. Устанавливаем зависимости проекта:

   ```

   pip install -r .\requirements.txt

   ```

5. Готовность номер один. Готовы к взлету.

### Запуск сервера

1. Запускаем сервер:

   ```

   python.exe -m uvicorn src.main:app --reload

   ```

2. Вы также можете добавить профиль запуска в вашей IDE. Он должен выглядеть следующим образом:

   ![run_profile](https://github.com/shasoka/needForFit_backend/assets/90062361/fcce8ed6-e659-4287-ab92-f4c623c62800)

3. Победа!

### Заметочка для повторного развертывания

База данных может изменяться в своей структуре от версии к версии, поэтому иногда приходится ее "пересобирать".

Рекомендую перед выполнением psql-команд отключить все соединения с БД "nff".

Сделать это можно или в PgAdmin или в IDE. Например так:

![conn_off](readme_images/conn_off.jpg)