This repository is out of date. We recommend using our WebComponent generator instead.
=====================
=====================
=====================
A slush generator for BioJS packages.
Install slush-biojs globally:
npm install -g slush-biojsRemember to install slush globally as well, if you haven't already:
npm install -g slushWarning: You might need to use sudo.
You can also setup npm to install packages into your userdir.
Create a new folder for your project:
mkdir my-moduleRun the generator from within the new folder:
cd my-module && slush biojsnpm run provides a run environment with all locally installed modules in the
PATH var. So if you hate typing, you can install the programm globally (-g).
Allows you to write minimal example snippets of your visualization. These snippets will be used for the BioJS registry and each snippet can visualize for one specific use case of your component (e.g. adjusting the menubar or changing default color). Those snippets can later be easily edited in a web editor like JSBin and thus should be minimal. A rule of thumb maximum for a snippet is 10 lines (otherwise your component is probably really hard to use).
npm run sniper
and open http://localhost:9090/examples
Executed command: biojs-sniper
Watches all your files and runs browserify on every change. Combine this with the sniper. (Subsequent runs of watchify are fast).
npm run watch
Executed command: gulp watch
npm run test
Executed command: gulp test
They are grouped into two sections:
- Non-DOM
gulp test-unit(folder:test/unit) - DOM-only
gulp test-dom(folder:test/dom)
Gotchas:
- The Unit tests are run with PhantomJS, if you want to debug them open the
test/index.htmlyour browser. - You need to add your DOM tests to the
test/dom/index.js.
If you want to auto-execute all your test on a file change, run:
npm run test-watch
The will run parcelify and bundle all your CSS resources.
npm run css
(you can add transforms for SASS or LESS and use the npm run watch-css to constantly watch for css changes)
Learn more about CSS Stylesheets in BioJS
npm run w
This will be available depending on your slush configuration. It is an alias for:
prunner "npm run task1" "npm run task2"
Prunner allows on to run multiple npm tasks in one shell.
Normally at least npm run sniper and npm run watch are included in this. Check your package.json for your exact configuration.
- command line arguments (parsed by minimist)
- environment variables prefixed with
slush-biojs_ - if you passed an option
--config filethen from that file - a local
.slush-biojsrcor the first found looking in./ ../ ../../ ../../../etc. $HOME/.slush-biojsrc$HOME/.slush-biojs/config$HOME/.config/slush-biojs$HOME/.config/slush-biojs/config/etc/slush-biojsrc/etc/slush-biojs/config
{
"authorName": "greenify",
"authorEmail": "[email protected]",
"userName": "greenify"
"license": "MIT"
}