Информационная система поддержки принятия управленцеских решений в области кадровой политики - Документация проекта

Данный проект состоит из монолитного Node.js + TypeScript REST бэкенда и React + Vite фронтенда. Все исходники проекта находятся в папке main.

Структура проекта

Весь основной код находится внутри директории main. Поэтому перед запуском любых команд необходимо перейти в неё:

cd main

Внутри папки main находятся следующие важные директории:

• /src - Исходный код фронтенда (React, компоненты, страницы, роутинг).
• /server - Исходный код бэкенда (Express, REST API, работа с базой данных).
• /prisma - Схема базы данных PostgreSQL и миграции.

Требования для локальной разработки

Для работы проекта локально вам понадобятся:

1. Node.js 18+ и npm
2. PostgreSQL (URL указывается в файле .env)
3. Ключ к Keycloak (задаётся в конфигурации, сервер Keycloak обычно поднят на http://127.0.0.1:8080)

Установка и запуск

1. Откройте терминал в папке проекта.
2. Перейдите в рабочую директорию: cd main
3. Установите зависимости: npm install
4. Настройте файл переменных окружения: создайте файл .env на основе .env.example.
5. Синхронизируйте базу данных с Prisma: npm run db:push
6. Запустите проект в режиме разработки. Вам нужно открыть два терминала в папке main:
   • Терминал 1 (Фронтенд): npm run dev (запускает Vite на http://127.0.0.1:3000)
   • Терминал 2 (Бэкенд): npm run dev:server (запускает Express API на порту 3001)

Дополнительные параметры

• npm run build - Сборка фронтенда в директорию main/dist.
• npm test - Запуск тестов.

Развертывание (Deployment)

Проект настроен на автоматический деплой на GitHub Pages через GitHub Actions. При пуше в ветку main запускается файл .github/workflows/deploy.yml, который собирает проект и выкладывает папку dist. Бэкенд должен крутиться на отдельном сервере, а его адрес должен быть указан в файле main/.env.production (параметр VITE_API_URL).