Проект на допуск #2

.editorconfig

@@ -0,0 +1,26 @@
+# Файл с настройками для редактора.
+#
+# Если вы разрабатываете в редакторе WebStorm, BBEdit, Coda или SourceLair
+# этот файл уже поддерживается и не нужно производить никаких дополнительных
+# действий.
+#
+# Если вы ведёте разработку в другом редакторе, зайдите
+# на https://editorconfig.org и в разделе «Download a Plugin»
+# скачайте дополнение для вашего редактора.
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.tsv]
+indent_style = tab
+indent_size = 2

.env.example

@@ -0,0 +1,12 @@
+HOST=myserver.com
+PORT=4000
+SALT=secret
+DB_HOST=127.0.0.1
+DB_USER=admin
+DB_PASSWORD=test
+DB_NAME=six-cities
+DB_MAX_RETRIES=3
+DB_RETRY_TIMEOUT=1000
+UPLOAD_DIRECTORY=upload
+STATIC_DIRECTORY=public
+JWT_SECRET=super-secret!

.eslintignore

@@ -0,0 +1,2 @@
+dist/
+frontend/

.eslintrc.yaml

@@ -0,0 +1,16 @@
+root: true
+env:
+  es2021: true
+  node: true
+parser: "@typescript-eslint/parser"
+parserOptions:
+  ecmaVersion: 2021
+  sourceType: module
+plugins:
+  - "@typescript-eslint"
+extends:
+  - "plugin:@typescript-eslint/recommended"
+  - "htmlacademy/node"
+rules:
+  'node/no-unsupported-features/es-syntax': 'off'
+  '@typescript-eslint/no-unsafe-declaration-merging': 'off'

.github/workflows/check.yml

@@ -0,0 +1,29 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '*'
+
+name: Project check
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '16'
+
+    - uses: actions/checkout@master
+      name: Checkout
+
+    - name: Install dependencies
+      run: |
+        if [ -f 'package.json' ]; then npm install; else echo 'Skip. The file package.json does not exist'; fi
+
+    - name: Run checks
+      run: |
+        if [ -f 'package.json' ]; then npm run lint; else echo 'Skip. The file package.json does not exist'; fi

.gitignore

@@ -0,0 +1,13 @@
+.vscode/
+/node_modules/
+/build/
+/lib/
+/dist/
+/docs/
+.idea/*
+/upload/
+
+.DS_Store
+coverage
+*.log
+.env

Contributing.md

@@ -0,0 +1,42 @@
+# Руководство по внесению изменений
+
+Поддерживайте ваш репозиторий обновлённым. Когда наставник принимает ваш пулреквест, он попадает в репозиторий Академии, но не в ваш форк.
+
+#### 1. Не коммитьте ничего самостоятельно в `master` вашего репозитория
+
+Это помешает вам аккуратно обновлять ваш репозиторий, могут возникнуть конфликты.
+
+#### 2. Прежде чем приступать к новому заданию, обновите `master`
+
+Обновить свой репозиторий из репозитория Академии можно так:
+
+```
+# В вашей локальной копии переключитесь в ветку master
+git checkout master
+
+# Заберите изменения из репозитория Академии¹
+git pull academy master
+
+# Отправьте изменения в ваш форк на Гитхабе
+git push
+```
+
+¹ В `academy` должна быть ссылка на репозиторий Академии. Если его там нет, добавьте:
+
+```
+git remote add academy git@github.com:htmlacademy-nodejs-api/196306-six-cities-5.git
+```
+
+Когда вы обновили `master`, создайте ветку для нового задания:
+
+```
+git checkout -b module2-task1
+```
+
+`module2-task1` — это название ветки. Под описанием каждого задания в интерфейсе интенсива для вас будет указано правильное название ветки.
+
+--
+
+#### Есть вопрос?
+
+Посмотрите [коллекцию часто задаваемых вопросов по Git](http://firstaidgit.ru).

Readme.md

@@ -0,0 +1,49 @@
+# Личный проект «Шесть городов»
+
+* Студент: [Елена Рашкован](https://htmlacademy.ru/profile/id196306).
+* Наставник: [Константин Ильин](https://htmlacademy.ru/profile/id2374827).
+
+---
+
+_Не удаляйте и не изменяйте папки и файлы:_
+_`.editorconfig`, `.gitattributes`, `.gitignore`._
+
+---
+
+## Памятка
+
+### 1. Зарегистрируйтесь на Гитхабе
+
+Если у вас ещё нет аккаунта на [github.com](https://github.com/join), скорее зарегистрируйтесь.
+
+### 2. Создайте форк
+
+Откройте репозиторий и нажмите кнопку «Fork» в правом верхнем углу. Репозиторий из Академии будет скопирован в ваш аккаунт.
+
+<img width="769" alt="Press 'Fork'" src="https://cloud.githubusercontent.com/assets/259739/20264045/a1ddbf40-aa7a-11e6-9a1a-724a1c0123c8.png">
+
+Получится вот так:
+
+<img width="769" alt="Forked" src="https://cloud.githubusercontent.com/assets/259739/20264122/f63219a6-aa7a-11e6-945a-89818fc7c014.png">
+
+### 3. Клонируйте репозиторий на свой компьютер
+
+Будьте внимательны: нужно клонировать свой репозиторий (форк), а не репозиторий Академии. Также обратите внимание, что клонировать репозиторий нужно через SSH, а не через HTTPS. Нажмите зелёную кнопку в правой части экрана, чтобы скопировать SSH-адрес вашего репозитория:
+
+<img width="769" alt="SSH" src="https://cloud.githubusercontent.com/assets/259739/20264180/42704126-aa7b-11e6-9ab4-73372b812a53.png">
+
+Клонировать репозиторий можно так:
+
+```
+git clone SSH-адрес_вашего_форка
+```
+
+Команда клонирует репозиторий на ваш компьютер и подготовит всё необходимое для старта работы.
+
+### 4. Начинайте обучение!
+
+---
+
+<a href="https://htmlacademy.ru/profession/fullstack"><img align="left" width="50" height="50" title="HTML Academy" src="https://up.htmlacademy.ru/static/img/intensive/nodejs/logo-for-github-2.png"></a>
+
+Репозиторий создан для обучения на профессиональном онлайн‑курсе «[Node.js. Профессиональная разработка REST API](https://htmlacademy.ru/profession/fullstack)» от [HTML Academy](https://htmlacademy.ru).

Workflow.md

@@ -0,0 +1,173 @@
+# Как работать над проектом
+
+## Запуск проекта
+
+Убедитесь, что на рабочем компьютере установлен актуальный LTS релиз **Node.js**. Актуальная версия **Node.js** указана в файле `package.json` в поле `node`.
+
+### Установите зависимости
+
+Выполните команду
+
+```bash
+npm install
+```
+
+### Разверните базу данных MongoDB
+
+В проекте используется база данных **MongoDB** версии 4.2.
+
+Если вы используете Docker, воспользуйтесь файлом `docker-compose.dev.yml`, расположенным в корне проекта, для быстрого разворачивания базы данных.
+
+### Наполните базу данных
+
+Запустите JSON-сервер с моковыми данными:
+
+```bash
+npm run mock:server
+```
+
+Сгенерируйте нужное количество предложений об аренде:
+
+```bash
+npm run cli -- --generate 100 ./mocks/mock-data.tsv http://localhost:3123/api                                                                                                                                                                                                                                         
+```
+
+Импортируйте данные в базу данных, используя настройки подключения из файла `docker-compose`:
+
+```bash
+npm run cli -- --import ./mocks/mock-data.tsv admin test 127.0.0.1 six-cities secret                                                                                                                                                                                                                                         
+```
+
+### Настройте переменные окружения
+
+В корне проекта находится файл `.env.example`. Скопируйте его содержимое в файл `.env` и настройте значения переменных.
+
+#### Переменные окружения
+
+```bash
+HOST=localhost - Имя хоста, на котором стартует сервер
+
+PORT=4000 - Порт для входящих соединений
+
+SALT=secret - Соль для хэширования паролей
+
+DB_HOST=127.0.0.1 - IP-адрес сервера базы данных (MongoDB)
+
+DB_USER=admin - Имя пользователя для подключения к базе данных
+
+DB_PASSWORD=test - Пароль для подключения к базе данных
+
+DB_PORT=27017 - Порт для подключения к базе данных (MongoDB)
+
+DB_NAME=six-cities - Имя базы данных (MongoDB)
+
+DB_MAX_RETRIES=3 - Максильмальное число попыток переподключения к БД
+
+DB_RETRY_TIMEOUT=1000 - Число миллисекунд между попытками подключения к БД
+
+UPLOAD_DIRECTORY=upload - Директория для хранения загружаемых пользователями файлов
+
+STATIC_DIRECTORY=public - Директория для хранения статических файлов
+
+JWT_SECRET=super-secret! - Секрет для подписи JWT-токена
+```
+
+### Запустите проект
+
+Выполните команду
+
+```bash
+npm start
+```
+
+## Сценарии
+
+В `package.json` предопределено несколько сценариев.
+
+#### Скомпилировать проект
+
+```bash
+npm run compile
+```
+
+Создаст директорию `dist` и скомпилирует проект.
+
+#### Удалить скомпилированный проект
+
+```bash
+npm run clean
+```
+
+Удаляет директорию `dist`. Используется перед компиляцией.
+
+#### Собрать проект
+
+```bash
+npm run build
+```
+
+Выполняет сборку проекта: удаляет ранее скомпилированный проект и компилирует заново.
+
+#### Проверить линтером
+
+```bash
+npm run lint
+```
+
+Запуск проверки проекта статическим анализатором кода **ESLint**.
+
+Линтер проверяет файлы только внутри директории `src`.
+
+**Обратите внимание**, при запуске данной команды, ошибки выводятся в терминал.
+
+#### Запустить ts-модуль без компиляции
+
+```bash
+npm run ts -- <Путь к модулю с ts-кодом>
+```
+
+Пакет `ts-node` позволяет выполнить TS-код в Node.js без предварительной компиляции. Используется только на этапе разработки.
+
+#### Запустить проект
+
+```bash
+npm start
+```
+
+В процессе запуска проекта будет выполнен процесс «Сборки проекта» и запуска результирующего кода.
+
+#### Запустить проект в режиме разработки
+
+```bash
+npm run start:dev
+```
+
+#### Запустить JSON-server с моковыми данными
+
+```bash
+npm run mock:server
+```
+
+#### Запустить консольную утилиту
+
+```bash
+npm run cli
+```
+
+## Структура проекта
+
+### Директория `src`
+
+Исходный код проекта: компоненты, модули и так далее. Структура директории `src` может быть произвольной.
+
+### Файл `Readme.md`
+
+Инструкции по работе с учебным репозиторием.
+
+### Файл `Contributing.md`
+
+Советы и инструкции по внесению изменений в учебный репозиторий.
+
+### Остальное
+
+Все остальные файлы в проекте являются служебными. Пожалуйста, не удаляйте и не изменяйте их самовольно. Только если того требует задание или наставник.

docker-compose.dev.yml

@@ -0,0 +1,27 @@
+version: '3.9'
+services:
+  db:
+    image: mongo:4.2
+    restart: always
+    container_name: six-cities_mongodb
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: ${DB_USER}
+      MONGO_INITDB_ROOT_PASSWORD: ${DB_PASSWORD}
+    ports:
+      - '27017:27017'
+    volumes:
+      - six-cities_data:/data/db
+
+  db_ui:
+    image: mongo-express:latest
+    restart: always
+    container_name: six-cities_mongo_express
+    environment:
+      ME_CONFIG_MONGODB_ADMINUSERNAME: ${DB_USER}
+      ME_CONFIG_MONGODB_ADMINPASSWORD: ${DB_PASSWORD}
+      ME_CONFIG_MONGODB_URL: mongodb://${DB_USER}:${DB_PASSWORD}@db:27017/
+    ports:
+      - '8081:8081'
+
+volumes:
+  six-cities_data: