node-express-sequelize-boilerplate

Boilerplate project for simple start with express, node and sequelize orm with migrations and seeds

Usage no npm install needed!

<script type="module">
  import nodeExpressSequelizeBoilerplate from 'https://cdn.skypack.dev/node-express-sequelize-boilerplate';
</script>

README

Server

npm start for start development

logs

For colorfull logs i use chalk library, here.
This use with Log class example. Is it here /server/config/color.log.js.
const log = new Log();
log.debug('message text');

For logging some information on files use winston module, is it here /server/config/winston.js.
This application have next log states, info and err. on logs folder we have app.log file for combine logs and error.log file for all errors.
Usage: winston.info(`message')

Syntax

For development use ES Next syntax. We have async/await and class syntax.

Start Development

Чтобы начать разработку нужно установить все зависимости проекта, а так же настроить базу данных. Измените название файла db_config.dist на config.json и впишите данные пользователя базы данных в поля в обьекте 'development'. После этого вам нужно провести все миграции и заполнить базу данных тестовыми данными. Перейдите в папку сервера, cd server и вводите команды по очереди:

  • Миграции node_modules/.bin/sequelize db:migrate
  • Тестовые данные node_modules/.bin/sequelize db:seed:all

Чтобы ознакомится с командами Sequelize советую почитать доку.

Актуальные роуты сервера находятся в папке server/routes