`project-starter`

A Javascript project environment ready for coding with zero config.

Setup

This project works best in VSCode with the Prettier Code Formatter extension installed.

To use, clone this repo:

git clone git@github.com:cassandraoconnell/project-starter.git

In the same directory you cloned this repo, run this command to rename your project and move into its directory (replacing [your-project-name] with, well, your project's name):

mv project-starter [your-project-name] && cd ./[your-project-name]

Do the following cleanup:

rm README.md LICENSE && rm -rf .git/

Add the following fields to package.json (filled with your information):

{
  "name": "",
  "version": "",
  "description": "",
  "author": "",
  "license": "",
  "repository": ""
}

And finally, run:

npm install

Writing/Running Tests

All test files must be named in the format *.test.js. To run all tests:

npm run test

Packages Included

eslint - For checking syntax and finding problems.
jest - For running tests.
prettier - For automatic code style enforcement and formatting.