NPM Library Template

This template is for creating NPM module libraries

What this template does for you

• Provides a .gitlab-ci.yml to manage the CI/CD pipeline
• Runs your Unit Tests with every push to the remote
• Analyzes your code with linting rules
• Will eventually run a SAST check
• Pushes your code coverage analysis to SonarQube
• Ensures your code passes the SonarQube Quality Gate
• Utilizes Semantic Release, which means the pipeline will handle versioning
• Publishes your module to npmjs

To use this template, follow these steps:

1. Setting up your local environment for Node development

If you are not set up to develop Node modules, follow these instructions:

• Mac
• Windows

2. Create a new project in Gitlab from this template

1. Under Application Development, go to the Group or Sub-group where you want to create your new project.
2. Click on New project.
3. Select Create from template
4. Select Group
5. You'll find NPM Library Template, then click on Use template
6. Finish creating your new project

3. Adding rules to your new project repository

• NEED TO DO

4. Clone your new project to your development environment

5. Update your new project with your project specific settings and information

1. Replace the README.md with a proper readme that will be displayed on npmjs
2. Update your the following settings in your package.json

{
  "name": "npm-library-template",
  "description": "The description that will amaze and astound your audience when they read it",
  "repository": {
    "type": "git",
    "url": "[email protected]:ns-am/templates/npm-library-template.git"
  },
  "author": "Ian Harisay <[email protected]>",
  "homepage": "https://code.tls.nuskin.io/ns-am/templates/npm-library-template/blob/master/README.md"
}