Git Product home page Git Product logo

es6-library-boilerplate's Introduction

ES6 Karma Jasmine Webpack Boilerplate

Build Status Coverage Status should be red because example is purposely not fully covered Dependency Status devDependency Status Sauce Test Status

No Grunt/Gulp required!

Boilerplate for building a client-based JavaScript library in ES6 using the following features

Table of Contents

  1. Configure Steps
  2. Features
  3. Usage

Configure

  1. Change package.json main field to your library_name.js
  2. Change package.json build scripts from Calculator to your library_name.js
  3. Change webpack.config.base.js library field from calculator to your library_name
  4. Make your library while npm run test:dev is executing
  5. Setup Travis CI
  6. Setup Coveralls.io
  7. Setup saucelabs
  8. Added the SAUCE_USERNAME and SAUCE_ACCESS_KEY enviroment variables to Travis CI
  9. Update sauceLaunchers in saucelab_browsers.js
  10. Push code to github to share (should trigger Travis, sauceLabs, and Coveralls)

Features

Usage

  • npm run test - Runs unit tests with Karma and generates a coverage report
  • npm run test:dev - Runs Karma and watches for changes to re-run tests also runs view-coverage
  • npm run test:web - same as test but runs them in Chrome
  • npm run test:dev:web - same as test:dev but runs them in Chrome
  • npm run view-coverage - Runs a watching server on the code coverage folder and opens it at port 3001
  • npm run lint- Lint all .js files.
  • npm run lint:fix - Lint and fix all .js files. Read more on this.
  • npm run clean - removes the dist and build folders
  • npm run build - produces your library

Credits

es6-library-boilerplate's People

Contributors

curtishumphrey avatar doque avatar zyml avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.