Доработки и исправления

.env-example → .env.example

@@ -10,5 +10,7 @@ DB_PASSWORD=password
 DB_NAME=six-cities-2
 DB_PORT=27017
 UPLOAD_DIRECTORY=upload
+STATIC_DIRECTORY_PATH=static
 
 JWT_SECRET=secret
+DEFAULT_USER_PASSWORD = password

Workflow.md

@@ -10,69 +10,128 @@ npm install
 
 Команда запустит процесс установки зависимостей проекта из **npm**.
 
-### Сценарии
+## Запуск проекта
 
-В `package.json` предопределено несколько сценариев.
+Ниже приведён рекомендуемый порядок локального запуска проекта.
 
-#### Скомпилировать проект
+### 1. Установить зависимости
+
+Если зависимости ещё не установлены, выполните:
 
 ```bash
-npm run compile
+npm install
 ```
 
-Создаст директорию `dist` и скомпилирует проект.
+### 2. Подготовить файл `.env`
+
+Приложение читает настройки из файла `.env`. Создайте его в корне проекта и укажите основные переменные окружения:
+
+```env
+PORT=3000
+SALT=iamsalt
+HOST=27.0.0.1
+DB_HOST=localhost
+DB_USER=admin
+DB_PASSWORD=test
+DB_PORT=27017
+DB_NAME=six-cities-2
+UPLOAD_DIRECTORY=upload
+STATIC_DIRECTORY_PATH=static
+JWT_SECRET=secret
+```
 
-#### Удалить скомпилированный проект
+Назначение переменных:
 
-```bash
-npm run clean
-```
+- `PORT` - порт, на котором будет запущен REST API.
+- `SALT` - соль для хеширования паролей.
+- `HOST` - хост приложения.
+- `DB_HOST`, `DB_USER`, `DB_PASSWORD`, `DB_PORT`, `DB_NAME` - параметры подключения к MongoDB.
+- `UPLOAD_DIRECTORY` - директория для загружаемых файлов.
+- `STATIC_DIRECTORY_PATH` - директория со статическими файлами.
+- `JWT_SECRET` - секрет для подписи JWT.
+- `DEFAULT_USER_PASSWORD` - пароль по умолчанию для создания новых пользователей при выполнении импорта.
+
+### 3. Запустить MongoDB
 
-Удаляет директорию `dist`. Используется перед компиляцией.
+Перед стартом приложения убедитесь, что сервер MongoDB запущен и доступен по параметрам из `.env`. Если база не будет доступна, REST API не сможет завершить инициализацию.
 
-#### Собрать проект
+### 4. Собрать проект
 
 ```bash
 npm run build
 ```
 
 Выполняет сборку проекта: удаляет ранее скомпилированный проект и компилирует заново.
 
-#### Проверить линтером
+### 5. Запустить REST API
+
+Для обычного запуска используйте:
 
 ```bash
-npm run lint
+npm start
 ```
 
-Запуск проверки проекта статическим анализатором кода **ESLint**.
+Команда выполнит сборку и запустит сервер из `dist/main.rest.js`.
 
-Линтер проверяет файлы только внутри директории `src`.
+### 6. Запустить проект в режиме разработки
 
-**Обратите внимание**, при запуске данной команды, ошибки выводятся в терминал.
-
-#### Запустить ts-модуль без компиляции
+Во время разработки удобнее использовать:
 
 ```bash
-npm run ts -- <Путь к модулю с ts-кодом>
+npm run start:dev
 ```
 
-Пакет `ts-node` позволяет выполнить TS-код в Node.js без предварительной компиляции. Используется только на этапе разработки.
+Этот сценарий также пересобирает проект перед запуском, а затем поднимает сервер через `nodemon` и выводит форматированные логи через `pino-pretty`.
+
+### 7. При необходимости поднять мок-сервер
 
-#### Запустить проект
+Если нужен локальный источник тестовых данных, выполните:
 
 ```bash
-npm start
+npm run mock:server
 ```
 
-В процессе запуска проекта будет выполнен процесс «Сборки проекта» и запуска результирующего кода.
+После этого `json-server` поднимет мок-сервер на порту `3123`.
 
-#### Запустить моковый сервер
+## Сценарии
 
-```bash
-npm run mock:server
-```
+В `package.json` предопределены следующие сценарии:
+
+### `npm start`
+
+Собирает проект и запускает REST API из `dist/main.rest.js`. Основной сценарий для локального запуска приложения.
+
+### `npm run start:dev`
+
+Собирает проект и запускает REST API в режиме разработки через `nodemon`. Подходит для разработки, когда важно автоматически перезапускать сервер и видеть читаемые логи.
+
+### `npm run build`
+
+Полная сборка проекта: сначала удаляет старую директорию `dist`, затем компилирует TypeScript-код заново.
+
+### `npm run lint`
+
+Проверяет код в директории `src` линтером **ESLint**. Используется после изменений и перед сдачей проекта, чтобы убедиться, что код соответствует правилам.
+
+### `npm run compile`
+
+Компилирует TypeScript в JavaScript по конфигурации из `tsconfig.json`. Удобно использовать, если очистка `dist` не требуется.
+
+### `npm run clean`
+
+Удаляет директорию `dist` с результатом предыдущей сборки. Обычно используется как подготовительный шаг перед новой компиляцией.
+
+### `npm run ts -- <путь-к-файлу>`
+
+Запускает TypeScript-файл напрямую через `ts-node` без предварительной сборки. Полезно для отладки отдельных модулей и запуска служебных скриптов во время разработки.
+
+### `npm run cli -- <аргументы>`
+
+Собирает проект и запускает CLI-приложение из `dist/main.cli.js`. Используется для работы с консольными командами проекта.
+
+### `npm run mock:server`
 
-Используется для работы команды `--generate` для генерации тестовых данных.
+Запускает `json-server` на порту `3123` с данными из `mocks/mock-server-data.json`. Используется для работы команды `--generate` для генерации тестовых данных.
 
 ## Структура проекта
 

package.json

@@ -16,6 +16,7 @@
     "compile": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "ts": "node --loader ts-node/esm",
+    "cli": "npm run build && node ./dist/main.cli.js",
     "mock:server": "json-server ./mocks/mock-server-data.json --port 3123"
   },
   "devDependencies": {