... (demo)
- Cytoscape.js ^3.2.0
Download the library:
- via npm:
npm install cytoscape-my-extension
, - via bower:
bower install cytoscape-my-extension
, or - via direct download in the repository (probably from a tag).
Import the library as appropriate for your project:
ES import:
import cytoscape from 'cytoscape';
import myExtension from 'cytoscape-my-extension';
cytoscape.use( myExtension );
CommonJS require:
let cytoscape = require('cytoscape');
let myExtension = require('cytoscape-my-extension');
cytoscape.use( myExtension ); // register extension
AMD:
require(['cytoscape', 'cytoscape-my-extension'], function( cytoscape, myExtension ){
myExtension( cytoscape ); // register extension
});
Plain HTML/JS has the extension registered for you automatically, because no require()
is needed.
TODO describe the API of the extension here.
-
npm run test
: Run Mocha tests in./test
-
npm run build
: Build./src/**
intocytoscape-my-extension.js
-
npm run watch
: Automatically build on changes with live reloading (N.b. you must already have an HTTP server running) -
npm run dev
: Automatically build on changes with live reloading with webpack dev server -
npm run lint
: Run eslint on the source
N.b. all builds use babel, so modern ES features can be used in the src
.
This project is set up to automatically be published to npm and bower. To publish:
- Build the extension :
npm run build:release
- Commit the build :
git commit -am "Build for release"
- Bump the version number and tag:
npm version major|minor|patch
- Push to origin:
git push && git push --tags
- Publish to npm:
npm publish .
- If publishing to bower for the first time, you'll need to run
bower register cytoscape-my-extension https://github.com/my-org/demo_trial.git
- Make a new release for Zenodo.