# node-express-sequelize-boilerplate
> Boilerplate project for simple start with express, node and sequelize orm with migrations and seeds
Latest version **1.0.1** (published 2018-10-26) · MIT license · 0 weekly downloads
## Install
```sh
npm install node-express-sequelize-boilerplate
pnpm add node-express-sequelize-boilerplate
yarn add node-express-sequelize-boilerplate
bun add node-express-sequelize-boilerplate
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-10-26 |
| First published | 2018-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 28 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 (+14 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Fedor Rychkov |
| Maintainers | fedorrychkov |
| Keywords | node, express, api, rest, api, orm, sequelize, es6, class, endpoints, simple, start, start, creation |
## Links
- npm: https://www.npmjs.com/package/node-express-sequelize-boilerplate
- Repository: https://github.com/Fedorrychkov/node-express-sequelize-boilerplate
- Homepage: https://github.com/Fedorrychkov/node-express-sequelize-boilerplate#readme
- Issues: https://github.com/Fedorrychkov/node-express-sequelize-boilerplate/issues
- npm.io page: https://npm.io/package/node-express-sequelize-boilerplate
## Dependencies (28)
- [hbs](https://npm.io/package/hbs.md) ^4.0.1
- [url](https://npm.io/package/url.md) ^0.11.0
- [boom](https://npm.io/package/boom.md) ^7.2.0
- [cors](https://npm.io/package/cors.md) ^2.8.4
- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [dotenv](https://npm.io/package/dotenv.md) ^6.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [moment](https://npm.io/package/moment.md) ^2.22.2
- [mysql2](https://npm.io/package/mysql2.md) ^1.6.1
- [express](https://npm.io/package/express.md) ^4.16.4
- [nocache](https://npm.io/package/nocache.md) ^2.0.0
- [nodemon](https://npm.io/package/nodemon.md) ^1.18.5
- [winston](https://npm.io/package/winston.md) ^3.1.0
- [sequelize](https://npm.io/package/sequelize.md) ^4.41.0
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.3
- [compression](https://npm.io/package/compression.md) ^1.7.3
- [pretty-error](https://npm.io/package/pretty-error.md) ^2.1.1
- [app-root-path](https://npm.io/package/app-root-path.md) ^2.1.0
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.3
- [sequelize-cli](https://npm.io/package/sequelize-cli.md) ^5.2.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [express-logging](https://npm.io/package/express-logging.md) ^1.1.1
- [babel-preset-env](https://npm.io/package/babel-preset-env.md) ^1.7.0
- [express-handlebars](https://npm.io/package/express-handlebars.md) ^3.0.0
- [babel-plugin-transform-class-properties](https://npm.io/package/babel-plugin-transform-class-properties.md) ^6.24.1
- [babel-plugin-transform-object-rest-spread](https://npm.io/package/babel-plugin-transform-object-rest-spread.md) ^6.26.0
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 1.0.1 (latest) — 2018-10-26
- 1.0.0 — 2018-10-26
## README
# Server
`npm start` for start development
## logs
For colorfull logs i use chalk library, [here](https://github.com/chalk/chalk).
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 советую почитать [доку](http://docs.sequelizejs.com/manual/tutorial/migrations.html#installing-cli).
Актуальные роуты сервера находятся в папке server/routes
---
_Source: https://npm.io/package/node-express-sequelize-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._