niViz

niViz Git Source Tree

Root/README.md

1niViz - Snowpack Visualization
2==============================
3
4Setup
5-----
6Ensure that Node.js and make are available on your system:
7
8 $ node -v
9 v8.5.0
10 $ make -v
11 GNU Make 4.0
12
13Then run `make dep` to fetch and install all dependencies. At any
14time, you can run `make purge` to remove all downloaded dependencies
15completely.
16
17After this, `make server` starts a web server you can use for
18development of the GUI; `make build` builds all applications;
19`make dist` builds and compresses/minifies all applications.
20
21Testing
22-------
23You can run the tests for the visualization library and the GUI
24in Phantom JS (or a regular browser by visiting localhost at port
259876); additionally, the library tests can be run with Node.js or
26in the Node debugger.
27
28 $ make test # Run all tests in Phantom JS
29 $ make coverage # Compile test coverage in Phantom JS
30 $ make watch # Start karma on port 9876
31
32 $ make test-node # Run library tests in Node.js
33 $ make debug-node # Run library tests in Node.js debugger
34
35Documentation
36-------------
37Run `make doc` to generate the html API documentation in `./doc`.

Archive Download this file

Branches