88888888ba 88 88 ad88888ba ad888888b,88 "8b "" 88 d8" "8b d8" "8888 ,8P 88 Y8, a8P88aaaaaa8P' 88 ,adPPYba, 88 `Y8aaaaa, ,d8P"88""""""8b, 88 a8" "8a 88 `"""""8b, a8P"88 `8b 88 8b d8 88 `8b a8P'88 a8P 88 "8a, ,a8" 88, ,d88 Y8a a8P d8"88888888P" 88 `"YbbdP"' "Y8888P" "Y88888P" 88888888888
BioJS builds a infrastructure, guidelines and tools to avoid the reinvention of the wheel in life sciences (= "Docker for Bio web components"). Our community builds modules than can be reused by anyone and makes them available for download via a centralised registry.
For BioJS 2.0 every component is a separate github repository. To search for a package, visit our registry. This repo is kept as intro guide and discussion repo. Feel free to open an issue (questions, suggestions, proposal or bug reports here) or to submit a component wish.
However you are still invited to show your interest in this project by starring this repo.
A web browser. For convenience you can grab a recent CDN version of
Normally the author provides also provides you with a minimized version of his component, but you can always easily build it yourself by running "npm run build-browser".
In general the
README.md of each project should explain you how to interact with it.
For visualization components you can just copy the JSBin or Codepen example.
You can also add it as a dependency of your project by using
npm install <package> --save.
Clone the package an run
npm install # this downloads all the dependencies of a packagenpm test # optionalnpm run build-browser # this will generate a JS file usuable in every browser (normally in the build folder)
Working examples of the component can be found in the
snippets folder of a package.
Even tough you can easily install node on Windows, a Unix-like OS is generally a more productive development enviroment.
↝ read our guide
To bootstrap a new project you can use the BioJS slush generator.
npm install -g slush slush-biojsmkdir biojsAWesome && cd biojsAwesomeslush biojs
↝ read our sniper.
Especially the snippets should give one a quick start on how to use a component.
You are now ready to enjoy the benefits of npm. For common use cases (requests, drag and drop, promises) you will always find plenty of npm modules.
Our gold standards are conventions we highly encourage you to follow (especially for JS beginners). They will help you to create a great package!
Just publish it on npm.
Here are some general ideas:
For technical queries (questions, suggestions, proposal or bug reports) Github issues are preferred.
↝ We have a community-based wiki. Some topics include:
We maintain a learning platform edu.biojs.net.
Pull requests are welcome.