lambda-test

NPM module template

Small template for building NPM modules.

This App follows Sustainable App Manifest

---

1. NPM Tasks
2. How To Use
3. Developing in right Node.js environment
4. Conributing

NPM Tasks

• $ npm test - runs automatic tests (linter, coverage, unit & API tests)
• $ npm run test:backend - run backend unit & API test
• $ npm run test:backend:watch - run and watch backend unit & API test
• $ npm run test:coverage - run coverage test
• $ npm run test:coverage:threshold - run coverage threshold test
• $ npm run test:lint - run eslint test

How To Use

1. Fork the project
2. Clone your fork
3. Rename the root directory and name atrribute in package.json
4. Run npm install command
5. And you're ready to start developing your own NPM module

Developing in right Node.js environment

• you can use NVM to manage multiple Node versions
• just specify wanted Node version in .nvmrc file

Contributing

• Follow AirBnB style guide
• Mind the Gitflow workflow
• Check ESLint settings in .eslintrc and ensure your ESLint is enabled
• (do the magick)
• run npm test to ensure everything is fine
• create feature branch at your fork and make pull request to upstream (ask App Owner)