/js-bootstrap-project

This is a default for a quick start project without thinking about settings

MIT LicenseMIT

Js Bootstrap Project

JavaScript Style Guide

This is a default for a quick start project without thinking about settings.

This project provides the following settings:

  • To test all JavaScript code: Jest
  • To style all JavaScript code: Standard
  • To monitor for any changes in your application: Nodemon
  • To git hooks made easy: Husky

Getting Started

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.

Pre requisites

Describe pre requisites for this project


Installing

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

Run the following command in Terminal:

$ npm install

Running the tests

The unit tests were built with support from the Jest framework

Break down into end to end tests

Easily run the unit test

$ npm test

Run live tests

$ npm run watch

And coverage tests

$ npm run coverage

Deployment

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

Contributing

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

Versioning

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

Authors

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

License

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