docs: readme

This commit is contained in:
Kirill 2022-12-19 17:07:16 +03:00
parent c30e0da3a3
commit 0e4a34bb6d
2 changed files with 14 additions and 15 deletions

@ -3,8 +3,8 @@
## Настройка и запуск ## Настройка и запуск
``` ```
1) yarn setup - загрузка всех зависимостей и инициализация husky 1) yarn setup - загрузка всех зависимостей и инициализация husky
2) yarn dev - запуск проекта в режиме разработки 2) yarn dev - запуск проекта в режиме разработки
``` ```
## Переменные окружения сервиса: ## Переменные окружения сервиса:
@ -12,26 +12,26 @@
**Для конфигурации сервера**: **Для конфигурации сервера**:
``` ```
ENVIRONMENT - application environment ENVIRONMENT - application environment
HTTP_HOST - service host HTTP_HOST - service host
HTTP_PORT - service port HTTP_PORT - service port
PUBLIC_ACCESS_SECRET_KEY - secret to verify private access secret key PUBLIC_ACCESS_SECRET_KEY - secret to verify private access secret key
``` ```
**Для конфигурации базы данных**: **Для конфигурации базы данных**:
``` ```
DB_HOST - mongo host DB_HOST - mongo host
DB_PORT - mongo port DB_PORT - mongo port
DB_USERNAME - mongo username DB_USERNAME - mongo username
DB_PASSWORD - mongo password DB_PASSWORD - mongo password
DB_NAME - database name DB_NAME - database name
``` ```
## Среды окружения ## Среды окружения
``` ```
development - среда для разработки development - среда для разработки
staging - среда для тестирования продукта staging - среда для тестирования продукта
production - среда продакшена production - среда продакшена
``` ```

@ -1,4 +1,3 @@
import { setRoleRoutes } from "@/routes/role.routes"; import { setRoleRoutes } from "@/routes/role.routes";
import type { FastifyInstance } from "fastify"; import type { FastifyInstance } from "fastify";