Merge pull request #14 from Karlen-ll/module9-task1

.env.example

@@ -1,15 +1,26 @@
+# Порт нашего api приложения на Node.js
 PORT=3100
+
+# Соль используемая при хешировании паролей
 SALT=hash
 
-# Docker
+# Логин для доступа к базе данных
 DB_USER=admin
+
+# Пароль для доступа к базе данных
 DB_PASS=test
+
+# IP адресс базы данных
 DB_HOST=127.0.0.1
+
+# Порт базы данных
 DB_PORT=27017
+
+# Имя базы данных
 DB_NAME=six-cities
 
-# UPLOAD
+# Директория для загрузки файлов
 UPLOAD_DIRECTORY=/home/node/app/upload
 
-# Auth
+# Секрет используемый при формировании JWT токенов.
 JWT_SECRET=secret

Workflow.md

@@ -2,25 +2,68 @@
 
 ## Окружение
 
-Для удобства работы над проектом используются инструменты из **Node.js** и **npm**. Все необходимые настройки произведены. Убедитесь, что на рабочем компьютере установлен актуальный LTS релиз Node.js**. Актуальная версия **Node.js** указана в файле `package.json` в поле `node`. Затем, в терминале, перейдите в директорию с проектом и _единожды_ запустите команду:
+При работе с проектом используются инструменты:  **Node.js**, **npm** & **Docker**.
+
+Все необходимые настройки произведены.
+Убедитесь, что на рабочем компьютере установлен актуальный **LTS** релиз **Node.js**.
+Актуальная версия **Node.js** указана в файле `package.json` в поле `node`.
+Затем, в терминале, перейдите в директорию с проектом и _единожды_ запустите команду:
 
 ```bash
 npm install
 ```
 
-Команда запустит процесс установки зависимостей проекта из **npm**.
+Команда запустит процесс установки зависимостей проекта из **npm**.
+
+### Переменные
+
+Переменные окружения описаны в файле [.env.example](.env.example).
 
 ### Сценарии
 
-В `package.json` предопределено несколько сценариев.
+В `package.json` предопределено множество сценариев.
+
+#### Запустить проект
+
+```bash
+npm start
+```
+
+В процессе запуска проекта будет выполнен процесс «Сборки проекта» и запуска результирующего кода.
+
+#### Сценарии для работы с CIL
+
+```bash
+npm run cli:help
+```
+```bash
+npm run cli:version
+```
+```bash
+npm run cli:import
+```
+```bash
+npm run cli:generate
+```
+
+#### Запуск Docker
+
+```bash
+npm run docker
+```
+
+или 
+```bash
+docker-compose up -d
+```
 
 #### Скомпилировать проект
 
 ```bash
 npm run compile
 ```
 
-Создаст директорию `dist` и скомпилирует проект.
+Создаст директорию `dist` и скомпилирует проект.
 
 #### Удалить скомпилированный проект
 
@@ -36,7 +79,7 @@ npm run clean
 npm run build
 ```
 
-Выполняет сборку проекта: удаляет ранее скомпилированный проект и компилирует заново.
+Выполняет сборку проекта: удаляет ранее скомпилированный проект и компилирует заново.
 
 #### Проверить линтером
 
@@ -48,7 +91,7 @@ npm run lint
 
 Линтер проверяет файлы только внутри директории `src`.
 
-**Обратите внимание**, при запуске данной команды, ошибки выводятся в терминал.
+**Обратите внимание**, при запуске данной команды, ошибки выводятся в терминал.
 
 #### Запустить ts-модуль без компиляции
 
@@ -58,14 +101,6 @@ npm run ts -- <Путь к модулю с ts-кодом>
 
 Пакет `ts-node` позволяет выполнить TS-код в Node.js без предварительной компиляции. Используется только на этапе разработки.
 
-#### Запустить проект
-
-```bash
-npm start
-```
-
-В процессе запуска проекта будет выполнен процесс «Сборки проекта» и запуска результирующего кода.
-
 #### Запустить JSON-server с данными, необходим для генерации тестовых данных
 
 ```bash
@@ -76,16 +111,19 @@ npm run mock:server
 
 ### Директория `src`
 
-Исходный код проекта: компоненты, модули и так далее. Структура директории `src` может быть произвольной.
+Исходный код проекта: компоненты, модули и так далее.
+Структура директории `src` может быть произвольной.
 
 ### Файл `Readme.md`
 
-Инструкции по работе с учебным репозиторием.
+Инструкции по работе с учебным репозиторием.
 
 ### Файл `Contributing.md`
 
-Советы и инструкции по внесению изменений в учебный репозиторий.
+Советы и инструкции по внесению изменений в учебный репозиторий.
 
 ### Остальное
 
-Все остальные файлы в проекте являются служебными. Пожалуйста, не удаляйте и не изменяйте их самовольно. Только если того требует задание или наставник.
+Все остальные файлы в проекте являются служебными.
+Пожалуйста, не удаляйте и не изменяйте их самовольно.
+Только если того требует задание или наставник.

package.json

@@ -13,10 +13,10 @@
     "start:rest": "nodemon -L",
     "build": "npm run clean && npm run compile",
     "cli:help": "npm run ts ./src/main.cli.ts -- --help",
-    "cli:version": "npm run ts ./src/main.cli.ts --version",
-    "cli:import": "npm run ts ./src/main.cli.ts --import mocks/mock-data.generated.tsv mongodb://admin:[email protected]:27017/six-cities?authSource=admin salt",
-    "cli:import:docker": "npm run ts ./src/main.cli.ts --import mocks/mock-data.generated.tsv mongodb://admin:admin@db:27017/six-cities?authSource=admin salt",
-    "cli:generate": "npm run ts ./src/main.cli.ts --generate 10 mocks/mock-data.generated.tsv http://localhost:3000/api",
+    "cli:version": "npm run ts ./src/main.cli.ts -- --version",
+    "cli:import": "npm run ts ./src/main.cli.ts -- --import mocks/mock-data.generated.tsv mongodb://admin:[email protected]:27017/six-cities?authSource=admin salt",
+    "cli:import:docker": "npm run ts ./src/main.cli.ts -- --import mocks/mock-data.generated.tsv mongodb://admin:admin@db:27017/six-cities?authSource=admin salt",
+    "cli:generate": "npm run ts ./src/main.cli.ts -- --generate 10 mocks/mock-data.generated.tsv http://localhost:3000/api",
     "docker": "docker compose --file ./docker-compose.yml --env-file ./.env --project-name \"six-cities\" up -d",
     "mock:server": "json-server ./mocks/mock-server-data.json --port 3000",
     "lint": "eslint ./src/ --ext .ts",