Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.89 KB

README.md

File metadata and controls

63 lines (43 loc) · 2.89 KB
Raw

library-server

Описание

Сервер для организации работы с библиотекой книг. Написан с образовательной целью и практической пользы на текущий момент не представляет.

Известные проблемы

  • При сборке в логах Cannot read property 'indent' of undefined -- можно игнорировать, это из-за старого webpack плагина, который я когда-нибудь обновлю

Технологии

  • koa - серверный фреймворк
  • passport - фреймворк для авторизации
  • sequelize - ORM
  • swagger-jsdoc - генерация OpenAPI Speck из jsdoc

Зависимости

Установка

  • git clone [email protected]:sintell/library-server.git

  • cd library-server

  • mkdir /path/to/db/dir

  • sqlite3 /path/to/db/dir/hh-library-dev.sqlite (команда может отличаться в зависимости от используемой ОС)

  • cp config/database.json.ex config/database.json

  • open config/database.json (редактируем строчки storage:, указывая актуальный путь)

  • yarn

Обновление

  • git fetch && git pull
  • yarn

Запуск

Development:

PORT=3000 DEBUG=* yarn dev-run (подробнее об использовании переменной DEBUG)

Production:

PORT=3000 yarn run

API

Актуальное API в виде OpenAPI 2.0 Speck (бывший swagger) может быть найдено при старте сервера по адресу http://localhost:3000/docs (порт приложения может отличаться и зависит от переменной окружения PORT)

Contributing

Все предложения принимаются и реализуются:

Все замечания и баги исправляются:

  • быстро - в виде issue
  • быстро и с благодарностью - в виде pull request

TODO

  • авторизация через Atlassian Jira
  • unit-tests
  • consistent errors