https://github.com/ksafranski/node-template

https://github.com/ksafranski/node-template

Last synced: about 23 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/ksafranski/node-template
• Owner: ksafranski
• Created: 2015-07-17T12:53:15.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-07-20T16:22:26.000Z (over 9 years ago)
• Last Synced: 2024-04-15T09:19:37.067Z (9 months ago)
• Language: Makefile
• Size: 184 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node Template Project

A NodeJS template project built for ES2015 development.

## Components:

* **[Babel](http://babeljs.io/)**: Code transpiler, see `/.babelrc` for config

* **[Mocha](http://mochajs.org/)**: Test runner

* **[Chai](http://chaijs.com/)**: Assertion library

* **[Sinon](http://sinonjs.org/)**: Stubbing and mocking, includes `sinon-chai` for assertions

* **[ESLint](http://eslint.org/)**: Linting, includes `babel-eslint` for ES2015 support

* **[ESDoc](https://esdoc.org/)**: JSDoc parser

## Makefile and Scripts

A `Makefile` is included for managing build and install tasks. The commands are

then referenced in the `package.json` `scripts` if that is the preferred

task method:

* `all` (default) will run all build tasks

* `start` will run the main script

* `clean` will remove the `/dist` and `/node_modules` directories

* `build` will transpile ES2015 code in `/src` to `/dist`

* `test` will run all spec files in `/test/src`

* `lint` will lint all files in `/src`

* `doc` will run ESDoc on all files in `/src` and output to `/docs`

* `dev` will run...

  * linting, then...

  * tests, then...

  * build/transpile, then...

  * the main script.

Both `make {COMMAND}` and `npm run {COMMAND}` work for any of the above commands.