readme.md

Node Developer Boilerplate

Node / yarn Boilerplate with Babel ES6 / ES7 Support, Testing, CI Integration, Code Coverage, JS Standard Style, Commit Guidelines, Git Hooks, Security Checks, Automatic Semantic Versioning, Benchmarking, Debugging, Monitoring, Source Map Generation, Auto Reload, Linting and more cool stuff ...

Project Status

Features

• Node optimized ES6 / ES7 Transpilation and Source Maps with Babel
• ES6+ aware Code Minification based on the Babel toolchain babili
• Restart Node on Application Changes with nodemon
• Code Debugging with babel-node-debug
• Node Server Performance Monitoring with nodejs-dashboard
• Javascript Linting with ESLint
• Javascript Code Style Standard
• Javascript Style Linting via eslint-config-standard
• Automatic Semantic Releasing with standard-version
• Code Benchmark Testing with benchmark.js
• Vulnerability scan via snyk
• ES6+ Testing via babel-register with Mocha, Chai, Sinon and sinon-chai
• Generate HTML Reports from tests via mochawesome
• ES6+ Code Coverage with babel-istanbul
• Ready for Continuous Integration & Delivery with travis-ci
• Use Standard Conventional Commit Messages via commitizen
• Commitizen Emoji Support for cz-conventional-changelog-emoji
• Automatic generate Changelog with Emoji Support conventional-changelog-angular-emoji
• Lint Commit Messages via conventional-changelog-lint
• Lint Markdown files with markdownlint
• Check if links in Markdown are online via markdown-link-check
• Lint .travis.yml with travis-lint
• Slack & Email Notifications for Builds via travis-ci
• Task Runner CLI via ntl
• npm scripts to get quick up and running

External Services

all used services are free to use for open source projects and quick registration via github authentication

• github - Modern Version Control System
• npmjs - Javascript Package Registry (optional: only if you want to publish to the npm registry)
• travis-ci - Continuous Integration & Delivery
• codecov.io - Code Coverage
• snyk.io - Fix and prevent known vulnerabilities in dependencies
• greenkeeper.io - Automated Dependency Management

In case you have to pass some secure token to Travis-CI i recommend the travis-cli tool for decryption and lots of other features. You can read more about it here. Linux / OS X Installation via sudo gem install travis. You can also set Token on GitHub in the Repository Settings.

Quickstart (npm)

git clone https://github.com/ellerbrock/node-developer-boilerplate
cd node-developer-boilerplate
npm install

Quickstart (yarn)

git clone https://github.com/ellerbrock/node-developer-boilerplate
cd node-developer-boilerplate
yarn

ECMAScript 2015 / ES6

Node.js comes with a huge set of ES6 features out of the box. A detailed list of supported features can be found at http://node.green. To speed things up and avoid transpiling natively supported features i recommend to install only the missing parts in your current Node Version:

• npm install --save-dev babel-preset-es2015-node6 - Node.js Version 6x
• npm install --save-dev babel-preset-es2015-node5 - Node.js Version 5x
• npm install --save-dev babel-preset-es2015-node4 - Node.js Version 4x
• npm install --save-dev babel-preset-es2015 - for all Node.js Versions

Info

At the moment im busy working on this boilerplate and lot stuff is changing.
When things getting more stable i will bump the version to 1.0.0 and write a detailed documentation.

Contact / Social Media

Get the latest News about Web Development, Open Source, Tooling, Server & Security

License

Copyright (c) 2016 Maik Ellerbrock