node package manager

cytoscape

Graph theory (a.k.a. network) library for analysis and visualisation

Cytoscape.js

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 library
  • clean : clean the build directory
  • watch : automatically build lib and tests for debugging
  • zip : build the release ZIP
  • dist : update the distribution JS for npm, bower, etc.

Testing:

  • test : run the Mocha unit tests
  • lint : lint the JS sources via jshint
  • benchmark : run benchmark regression tests
  • benchmark-single : run benchmarks only for the suite specified in benchmark/single
  • sniper : runs a BioJS sniper server that hosts demos

Documentation:

  • docs : build the documentation template
  • docsmin : build the documentation template with all resources minified
  • docspub : build the documentation for publishing (ZIPs, JS refs, etc.)
  • docspush : push the built documentation to js.cytoscape.org
  • unstabledocspush : push the built documentation to js.cytoscape.org/unstable
  1. Make sure the docs are updated with the list of releases in documentation/md/intro.md
  2. Update the VERSION environment variable, e.g. export VERSION=1.2.3
  3. Confirm JS files pass linting: gulp lint
  4. Confirm all tests passing: gulp test
  5. Test the docs and demos with the latest code: gulp docspub
  6. 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).