- Docker
- NodeJS >= 16
https://docs.docker.com/get-docker/
Мы рекоммендуем использовать Node Version Manager для удобного управления версиями node.js
Либо можно установить node.js отдельно
https://nodejs.org/en/download/
Для удобной работой с проектом мы используем GNU Make.
https://www.gnu.org/software/make/
По-умолчанию, GNU Make уже предустановлен на Unix операционных системах. Чтобы проверить установлени ли GNU Make на вашем компьютере выполните команду в терминале
make --version
В случае отстутствия GNU Make, мы рекоммендуем установить его.
В makefile доступны следующие команды
Установить зависимости для проекта
$ make install_dependencies
Запустить проект
$ make start_project
- Перейдите в директорию (выполнить из корня приложения)
cd frontend
- Установите зависимости
$ npm ci
В директории frontend возможно выполнить следующие скрипты:
npm run dev - запуск проекта (только клиент) в режиме разработки
npm run build - создание продакшн сборки проекта
npm run test:unit - запуск юнит тестов
npm run lint - запуск линтера
- Перейдите в директорию (выполнить из корня приложения)
cd backend
- Установите зависимости
$ npm ci
- Запуск сервера (для запуска необходима работающая база данных на порте :5432)
$ npm start
- Перейдите в директорию (выполнить из корня приложения)
cd template
- Установите зависимости
$ npm ci
- Запуск шаблонов
$ npm start
- Сборка проекта
$ docker compose build
$ docker compose down -v
$ docker compose up
Сервер будет доступен по адресу localhost:3000
Клиент будет доступен по адресу localhost:8080
| Внимание: требуется ручной запуск базы данных |
|---|
- Запуск базы данных
Запустите PostgreSQL базу данных
Обновите конфигурацию подключения базы данных для сервера в файле backend/src/datasources/database.datasource.ts
- Запуск сервера (выполнить из корня приложения)
cd backend && npm start
- Запуск клиента (выполнить из корня приложения)
cd frontend && npm run dev
Сервер будет доспупен по адресу localhost:3000
Клиент будет доспупен по адресу localhost:8080
Мы подготовили несколько готовых пользователей в базе данных. Список пользователей, электронные почты и пароли для входа доступны здесь
src/backend/src/factory/dummy-users.json
Документация доступна по адресу
http://localhost:3000/explorer/
$ make install_template_dependencies
$ make run_template
Перейдите в директорию template:
cd template
Установите зависимости, выполнив команду:
npm install
Запустите проект командой:
npm start
Шаблон и вёрстка будут доступны по адресу: http://localhost:9999.
Вёрстку можно посмотреть в директории template/src.