Jam3 Open Source Library Generator

Jam3 Open Source Library Generator with no build configuration and no prompts

• Usage
• Main scripts – Running scripts

Usage

nyg-opensource-jam3 is using nyg to generate the template, and should be installed first.

npm i nyg -g
npm i nyg-opensource-jam3 -g
cd your-project-directory
nyg nyg-opensource-jam3

Contribute

Structure

Contribute with boilerplate

1. Go to /templates
2. Run npm i
3. Ready to go, everything is inside that folder

Contribute with the generator

1. Review /index.js, everything is there

Boilerplate main scripts

In the template, you can run:

npm test

Runs the test watcher in an interactive mode

npm run test-ci

It runs a set of tasks previous to git push and in the Continues Integration service before merging.

The tasks are:

• Unit tests
• Linters
• Bundle size checking
• Dependencies vulnerability audit

Recommended Services

It's recommended to integrate the below services:

1. Snyk
2. Travis CI
3. Greenkeeper
4. Coveralls
5. David-dm
6. Code Climate
7. Sonar cloud
8. Bundle Size It's already include, but not integrated with the status in GitHub

After you start using the services you can move forward and add the badges in your Readme, to learn more use https://shields.io/