fm-ph/quark-router

🔗 Simple router

Simple router.

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

Installation

npm install quark-router --save

Usage

Basic

import Router from 'quark-router'

const routes = [{
  name: 'home',
  callback: route => { },
  path: '/'
}]
const router = new Router({ routes })

To be written...

API

See https://fm-ph.github.io/quark-router/

Build

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

npm run build

Documentation

To generate the JSDoc :

npm run docs

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

npm run docs:deploy

Testing

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

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

Then, run the tests :

npm test

To watch (test-driven development) :

npm run test:watch

For coverage :

npm run test:coverage

License

MIT License © Patrick Heng Fabien Motte