quark-package-starter/README.md at develop · fm-ph/quark-package-starter

Simple repository to start a new quark package.

This package is part of quark framework but it can be used independently.

Installation

npm install quark-simple --save

Basic example.

import Simple from 'quark-simple'

const simple = new Simple()
simple.test()

To build the sources with babel in ./lib directory :

npm run build

To generate the JSDoc :

npm run docs

To generate the documentation and deploy on gh-pages branch :

npm run docs:deploy

To run the tests, first clone the repository and install its dependencies :

git clone https://github.com/fm_ph/quark-package-starter.git
cd quark-package-starter
npm install

Then, run the tests :

npm test

To watch (test-driven development) :

npm run test:watch

For coverage :

npm run test:coverage