surikov-k / 598165-six-cities-3-api

Константин Суриков

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Личный проект «Шесть городов»


Памятка

1. Файл .env

  • SALT — соль
  • DB_USER — имя пользователя базы данных
  • DB_PASSWORD — пароль базы данных
  • DB_NAME — название базы данных
  • UPLOAD_DIRECTORY — директория для загрузки файлов
  • JWT_SECRET — jwt секрет
  • STATIC_DIRECTORY_PATH — директория для хранения статичных ресурсов
  • HOST — имя хоста, на котором запущен сервис

2. Запуск проекта

  1. Установит зависимости
    npm install
  2. Запустит json-сервер с моковыми данными
    npm run mock:server
  3. Сохранит данные для 10 предложений об аренде в файл /mocks/mock-data.tsv
    npm run ts src/cli.ts -- --generate 10 ./mocks/mock-data.tsv  http://localhost:2123/api
  4. Импортирует данные в БД
    npm run ts src/cli.ts -- --import ./mocks/mock-data.tsv admin test localhost six-cities-restapi salt
  5. Запустит дев-сервер
    npm run start:dev

2. Сценарии

  • start — соберет и запустит проект
  • start:dev — запустит дев-сервер
  • build — очистит /dist и скомпилирует проект
  • lint — линт
  • compile — скомпилирует ts
  • clean — очистит /dist
  • ts — ts-node
  • mock:server — запустит json-сервер с моковыми данными

Репозиторий создан для обучения на профессиональном онлайн‑курсе «Node.js. Профессиональная разработка REST API» от HTML Academy.

About

Константин Суриков


Languages

Language:TypeScript 72.3%Language:HTML 27.4%Language:JavaScript 0.2%Language:Shell 0.1%