/node-boilerplate

Includes some Babel, Webpack, Nodemon, Eslint , PM2 and Huskey particals. Good starting point for your awesome Node.JS server. Also Documentation and testing ready! 🤜🏻

Primary LanguageJavaScript

Node Boilerplate 🔥🥔

It's ready to eat! Just add water. Tada 🎉

Greenkeeper badge Maintainability Codacy Badge Conventional Commits

Features

  • Babel 7
  • Webpack
  • Eslint
  • Prettier
  • Github Actions
  • Documentation (JsDoc)
  • Test (Mocha)
  • PM2 (Serve)
  • Test Coverage (IDK?)
  • Appconveyor
  • Docker

Utils

  • nconf for your args, env and json config management
  • Winston For easy logging (file and console)
  • Lodash cherry pick 🍒👌
  • Signale Good looking console logging
  • Lint staged for preventing hot mess
  • Huskey for lint and testing hooks before commit and push
  • standard-version See

Init it! ⚡️

Just click Use this template button or

$ git clone https://github.com/stevenselcuk/node-boilerplate yourawesomeproject

$ cd yourawesomeproject

$ yarn

$ yarn dev

Build it! 🔧

$ yarn build

Start it! 🍍

$ yarn start

Serve it! 📦

$ yarn serve

Other Operations 🤔

Linting, fixing and running tests and prettier is in "auto mode" to preventing "hot mess" ( just commit and push it 🤜🏻)

Lint and fix your file

$ yarn lint

Run your mocha tests

$ yarn mocha

Generate your documentation

$ yarn doc

Folder Structure

.
├── /dist/ # Ready to serving files 🥘
├── /src/ # Your awesome Node project 💵
│   ├── /utils/ # Some helpers for you 👄
│        ├── logger.js # File/console Logging helper
│        ├── config.js # Manage and use your .env,args and config.json (Ready to use. Really)
│   ├── index.js # Your entry point!
└── /test/ # Mocha test files, config and helpers are here
└── /docs/ # Your generated documentation files (JSDoc)
└── /logs/ # Log files by logger.js and PM2
└── README.md # You are reading this
└── pm2.config.js # Some configs for running PM2
└── package.json # Node packages

🙌🏻 That's all brothers.