This is a simple starter kit for Javascript projects with a testing enviroment initialized.

1. Clone this repo
2. Delete this first sections of comments
3. Add your own description to the README.md template bellow.
4. Update de package.json information
5. Install dependencies running npm install

• Mocha for test runner
• Chai as assertion library
• Sinon as mocking library
• nyc (istanbul) for code coverage
• husky for git hooks
• Babel code transpailer
• ESLint (standard) for Javascript code style

Some usefull scripts:

• npm run test -> run tests once
• npm run test:watch -> run tests with watch flag ON
• npm run test:coverage -> run code coverage analysis

START: README.md Template

One Paragraph of project description goes here

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

What things you need to install the software and how to install them

Give examples

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Explain how to run the automated tests for this system

Add additional notes about how to deploy this on a live system

• Dropwizard - Bla bla bla
• Maven - Maybe
• Atom - ergaerga

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

We use SemVer for versioning. For the versions available, see the tags on this repository.

• Billie Thompson - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details

END: README.md Template

• This starter-kit is a fork of Willian Justen JS TDD Course Starter Kit.