Skip to content

Liftitapp/liftit-npm-es5-skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Ā 

History

5 Commits
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 

Repository files navigation

Codacy Badge Build Status

Liftit npm ES5 Skeleton

Features

  • Node optimized ES5 transpilation with Babel
  • Code monitoring and auto server restart with nodemon
  • ES5+ Testing via babel-register with Mocha & Chai
  • ES5 aware, minifier based on rollup rollup
  • HTML Test Report via mochawesome
  • Code Linting with ESLint
  • Sourcemap generation
  • Vulnerability scan via nsp
  • Check for latest versions of dependencies via ncu
  • Husky to run git hooks Husky
  • npm scripts included to run quick tasks

Setup

  • Step 1: git clone https://github.com/Liftitapp/liftit-npm-es5-skeleton.git <YourProjectName>
  • Step 2: cd <YourProjectName> && npm install
  • Step 3: start hacking

npm runners

Runner Description
npm start src executes the project with live reload enabled via nodemon and transpiled with `babel
npm run debug src executes the project with debug flag enabled
npm run benchmark runs benchmark tests with benchmark.js
npm run benchmark:watch runs benchmark tests with benchmark.js and watch for file changes
npm run lint code linting with eslint
npm run lint:fix fixes all problems automatically with eslint
npm test runs tests with mocha and chai with spec as reporter
npm run test:watch runs tests with mocha and chai and watch for changes
npm run test:reporter runs tests with mocha and chai with list reporter
npm run test:export exports tests results as html files in the ./reports folder via mochasome
npm run build transpiles and minifies ES6+ code and create sourcemaps with babel & babili
npm run scan:security runs vulnerability tests via the node security platform nsp
npm run scan:updates checks for latest versions of dependencies via ncu
npm run precommit runs git hooks withHusky
npm run prepush runs git hooks withHusky
npm run postmerge runs git hooks withHusky
npm run postrewrite runs git hooks withHusky

License

MIT Ā©

Copyright 2017 Liftit

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

liftit npm skeletonšŸ˜¬

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published