Graph theory (a.k.a. network) library for analysis and visualisation : http://js.cytoscape.org
master
unstable
You can find the documentation and downloads on the project website.
Please refer to CONTRIBUTING.md.
Install node, npm and gulp. Of course, npm install before using gulp.
Run gulp <target> in the console. The main targets are:
Building:
build(default) : build the libraryclean: clean thebuilddirectorywatch: automatically build lib and tests for debuggingzip: build the release ZIPdist: update the distribution JS for npm, bower, etc.
Testing:
test: run the Mocha unit testslint: lint the JS sources via jshintbenchmark: run benchmark regression testsbenchmark-single: run benchmarks only for the suite specified inbenchmark/singlesniper: runs a BioJS sniper server that hosts demos
Documentation:
docs: build the documentation templatedocsmin: build the documentation template with all resources minifieddocspub: build the documentation for publishing (ZIPs, JS refs, etc.)docspush: push the built documentation to js.cytoscape.orgunstabledocspush: push the built documentation to js.cytoscape.org/unstable
- Make sure the docs are updated with the list of releases in
documentation/md/intro.md - Update the
VERSIONenvironment variable, e.g.export VERSION=1.2.3 - Confirm JS files pass linting:
gulp lint - Confirm all tests passing:
gulp test - Test the docs and demos with the latest code:
gulp docspub - Build and publish the release:
gulp publish
Mocha tests are found in the test directory. The tests can be run in the browser or they can be run via Node.js (gulp test or mocha).