Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 2.15 KB

README.md

File metadata and controls

84 lines (54 loc) · 2.15 KB
Raw

Vn

Build Status Greenkeeper badge Maintainability Test Coverage

Visualization Library

Library to do heavy lifting of the ground work for visualization of analytics data, abstracting interaction of developer with analytics data sources.

Prequisites

  • node
  • git
  • npm
  • webpack
  • babel

Getting started

Clone the repository by running this command

$ git clone https://github.com/interactive-apps/visualization.git

Go to the app directory

$ cd visualization

Install all required dependencies for the app

$ npm install

Development environments

To start an application for testing your library,

  1. If you want to test your library over the browser then run

    $ npm run start:browser

The command will automatically open http://localhost:3000/. on your default browser.

  1. If you want to test your library over the terminal as nodejs script then run

    $ npm run start:node

NOTE: In both cases, the app will automatically reload if you change any of the source files inside app directory

Building library

To build your library, run

$ npm run build-lib

Publishing library

Inorder to publish your library in npm, make sure you already have npm account and have already logged in to npm in the command line tool of your computer, to login to npm run

$ npm login

You will be required to provide username and password for npm

To publish your library to npm run

$ npm run publish

If you are publishing to an npm organisation, make sure that you are member for that organisation