Возможен запуск в виде Docker-образа.
Бекенд-часть на базе Nest.js располагается в папке /server
, панель администратора на базе React.js - в /admin
, клиентская часть на базе Next.js - в /views
. Используемая БД: PostgreSQL.
Быстрый запуск:
git clone https://git.infostrategic.com/hse/webrtchse1
npm ci
npm run build
npm start
project/
├── admin/ Панель администратора (веб-фронтенд на React)
├── client/ Клиентский веб-сайт (веб-фронтенд на React/Next.js)
├── common/ Общие компоненты серверной и клиентской части
│ ├── dto/ Описания форматов DTO (Data Transfer Object)
│ ├── locales/ Файлы локализаций (русский, английский)
│ ├── models/ Описания моделей в базе данных
│ └── utils/ Дополнительные типы, утилиты
├── docs/ Документация проекта
├── server/ Серверная часть проекта (бекенд на Nest.js)
├── development.env Конфигурационный файл для разработки
├── docker-compose.json Файл развертывания Docker-сервера (база данных, бекенд)
├── Dockerfile Файл компиляции Docker-контейнера
├── production.env Конфигурационный файл для развертки на реальный сервер
└── README.md Файл краткого описания проекта
Конфигурационные переменные проекты предлагается хранить в файлах development.env
и production.env
для запуска соответственно среды для разработки и массового распространения.
Переменная | Функция | Рекомендуемое значение |
---|---|---|
JWT_SECRET |
Секретный ключ для подписания JSON Web Token | от 32 символов |
POSTGRES_HOST |
Адрес размещения базы данных PostgreSQL | |
POSTGRES_PORT |
Порт размещения базы данных PostgreSQL | 5432 |
POSTGRES_USER |
Пользователь-администратор СУБД PostgreSQL | |
POSTGRES_PASSWORD |
Пароль пользователя-администратора СУБД PostgreSQL | |
POSTGRES_DB |
Имя базы данных, с которой работает приложение | |
PORT |
Порт, через который доступен сервер | 8080 |