Проект команды BlackWeather по дисциплине "Информационные системы и технологии"

Разработка решения для оптимизации внутренних процессов крупного производственного холдинга

Участники команды:

1. Ксения
2. Илья
3. Никита
4. Даниил

Ссылка на решение

https://isit.blackweather.ru

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

Backend-приложение

Первый способ запуска (ручная сборка):

Инструкция

1. Установка необходимых компонентов: Python 3.12, Postgresql database, если запускать не через докер; Docker compose, тогда можно не скачивать Postgresql – https://www.python.org/downloads/ https://www.postgresql.org/download/ https://docs.docker.com/compose/install/
2. Открыть папку проекта с исходным кодом
3. Переопределить настройки в соответствии с рабочим окружением: cp app/config/local.yaml.tmpl app/config/local.yaml (пример файла далее)
4. Установите poetry, если его еще нет на вашей системе: pip install poetry
5. Запустить базу данных через docker compose командой docker compose up –build postgres, либо запустить базу данных локально
6. Провести миграции в базу данных командой poetry run alembic upgrade head
7. Настроить переменные окружения (.env) в корневой папке проекта (пример далее)
8. Теперь вы можете запустить сервер FastAPI: poetry run python3 app/main.py

Пример local.yaml

app:
HOST: 127.0.0.1
PORT: 7070
LLM_API_KEY: your_llm_key
LLM_FOLDER_ID: your_llm_folder
LLM_API_GATEWAY_LINK: your_llm_gateway_link

database:
POSTGRES_HOST: localhost
POSTGRES_PORT: 7511
POSTGRES_DB: postgres
POSTGRES_USER: user
POSTGRES_PASSWORD: !secret

cookies:
SECURE: false

# DOMAIN: example.ru

cors:
ORIGINS: - http://localhost:3000 - http://127.0.0.1:3000
DOMAIN: example.ru

security:
SECRET_KEY: dev-secret-change
ALGORITHM: your_algo

Пример .env

LOGS_PATH=/mnt/isit-backend/logs.json
GRAFANA_URL=http://remote_host:remote_port/loki/api/v1/push
SERVICE_NAME=isit-backend
ALLOY_PORT=7513
ALLOY_HOST=localhost

POSTGRES_PORT=7511
API_PORT=7512

Второй способ запуска (запуск с использованием контейнеризации):

Инструкция

1. Установка необходимых компонентов: Docker compose - https://docs.docker.com/compose/install/
2. Открыть папку проекта с исходным кодом
3. Переопределить настройки в соответствии с рабочим окружением: cp app/config/local.yaml.tmpl app/config/local.yaml (пример файла далее)
4. Настроить переменные окружения (.env) в корневой папке проекта (пример далее)
5. Запустить проект через docker compose командой docker compose up –build

Пример local.yaml:

app:
HOST: 127.0.0.1
PORT: 7070
LLM_API_KEY: your_llm_key
LLM_FOLDER_ID: your_llm_folder
LLM_API_GATEWAY_LINK: your_llm_gateway_link

database:
POSTGRES_HOST: postgres
POSTGRES_PORT: 5432
POSTGRES_DB: postgres
POSTGRES_USER: user
POSTGRES_PASSWORD: !secret

cookies:
SECURE: false

# DOMAIN: example.ru

cors:
ORIGINS: - http://localhost:3000 - http://127.0.0.1:3000
DOMAIN: example.ru

security:
SECRET_KEY: dev-secret-change
ALGORITHM: your_algo

Пример .env

LOGS_PATH=/mnt/isit-backend/logs.json
GRAFANA_URL=http://remote_host:remote_port/loki/api/v1/push
SERVICE_NAME=isit-backend
ALLOY_PORT=7513
ALLOY_HOST=localhost

POSTGRES_PORT=7511
API_PORT=7512

Frontend-приложение

Первый способ запуска

1. Установите Node.js (вместе с npm) с официального сайта https://nodejs.org
2. Проверьте установку командой node -v и npm -v
3. В папке проекта выполните команду npm i для установки зависимостей
4. Запустите проект командой npm run dev
5. Откройте в браузере адрес http://localhost:3000

Второй способ запуска (запуск с использованием контейнеризации):

1. Установка необходимых компонентов: Docker compose - https://docs.docker.com/compose/install/
2. Открыть папку проекта с исходным кодом
3. Настроить переменные окружения (.env) в корневой папке проекта (пример далее)
4. Запустить проект через docker compose командой docker compose up –build

Пример .env

APP_PORT=7510