slush-good-start

A slush generator for project with testing, eslint, config, testing, and webstorm project settings.

Usage no npm install needed!

<script type="module">
  import slushGoodStart from 'https://cdn.skypack.dev/slush-good-start';
</script>

README

Slush-Test

A slush generator for a simple node app with all the good stuff

Installation

Install slush-good-start globally:

npm install -g slush-good-start

Remember to install slush globally as well, if you haven't already:

npm install -g slush

Usage

Create a new folder for your project:

mkdir my-new-app

Run the generator from within the new folder:

cd my-new-app

slush good-start

Answer the questions and it will generate all the stuff you need.

Linting

It uses eslint and Airbnb's linting module

This can be ran via: npm run-script lint

Nodemon

It uses nodemon

This can be ran via: npm run-script nodemon

Testing

It uses mocha and chai and sinon

This can be ran via: npm run-script test

Logging

It uses bunyan and bunyan-prettystream

Other Modules

  • lodash
  • moment
  • config
  • async

Webstorm

It also include a nice configured webstorm project file

Precommit hooks

Linting and testing is ran prior to commits and will not commit on failure.