rasata/opensource-kit

Open source kit for people who writes nice code.

Open source kit for people who writes a nice code.

Create simple, flexible libraries without worry about production ready covered code. Simple and easy to use.

Do you wanna build you library with few lines of npm ?.

No need to find amazing-new-boilerplate-with-black-jack just use Open source kit.

You create a lib and just run npm run build thats all. Its clean minified uglified code with coverage.

Wanna help?

##Installation

$ git clone https://github.com/mr47/opensource-kit

bad idea but still available :

$ npm install opensource-kit

##Whats inside:

• Webpack (bundler, with demo external lib)
• Babel ( stage 0, es2015 )
• Karma (Runner for tests)
• Mocha (tests framework)
• Chai
• Isparta (coverage, es2015 source quality!)
• Sass (scss)
• ESLint

###Additional:

• .editorconfig
• .babelrc

###Demo:

• Webpack Dev Server
• Browser sync

##Publishing you package To follow semver use follow commands (before update version in package.json it runs npm run preversion)

To make a patch:

$ npm version patch

To make a minor change:

$ npm version minor

To make a major change:

$ npm version major

To publish package to npm:

$ npm publish

##Build Complete build to ./dist/

$ npm run build

Babel build ./lib/

$ npm run build:babel

Webpack build

$ npm run build:webpack

##Test It will run karma with config karma.conf.js

$ npm test

##Run Demo

$ npm run start

##Motivation I writed few big/small/zero projects last months, and tested my env. For many reasons i choose some components one by another so for now its my stack for javascript code.

##TODO

See issues.

##Node and npm version tested

#CONTRIBUTING Pull request are welcome, just fork repo.

Installation

Install dependencies using npm install.

Building

Build the source code using npm run build.

##License MIT