88888888ba 88 88 ad88888ba ad888888b,
88 "8b "" 88 d8" "8b d8" "88
88 ,8P 88 Y8, a8P
88aaaaaa8P' 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
We recently switched to a new concept, so maybe you are looking for the old BioJS 1?
You can already browse the new registry. Transition of components from BioJS1 is in progress.
- Represent consistently biological information across different projects
- Ease discovery, test and integration of graphical components
- Standardize and facilitate components development
↝ Summary presentation of the differences between BioJS1 and BioJS 2.0.
Old Components of BioJS 0.1 can rely on biojs-legacy. But we highly encourage you to write your code more modular.
We can ensure that if you have contributed with a component in the BioJS1 registry, it will continue to work in BioJS2. In fact we will script the migration and at some day in November or December migrate all remaining BioJS1 components. The final update of the EBI registry will be at the end of this year.
↝ There are many ways to contact us
For technical queries (questions, suggestions, proposal or bug reports) Github issues are preferred.
For BioJS 2.0 every component is a separate github repository - here you see only the template project for our 101 tutorial. To search for a package, visit our registry.
We are working on a new platform edu.biojs.net. Pull requests are welcome.
For beginners there is a BioJS 2 101 tutorial series. For a quick migration to BioJS 2 we created this document.
A tiny building block like a FASTA parser or a visualization piece. If it obeys the rule "do one thing and do it well" , then it is (most likely) a package. The BioJS packages are published on the JavaScript package manager npm.
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.
We have a few guidelines like
- biojs-events (Convention for the Observer pattern)
- example snippets (coming soon: generic snippets on JSBin)
Especially the snippets should give you a quick start on how to use a component.
Our gold standards are conventions we highly encourage you to follow (especially for JS beginners). They will help you to create a great package!
Detailed installation instructions.
Even tough you can easily install node on Windows, a Unix-like OS is generally a more productive development enviroment.
In the package folder
npm install # this downloads all the dependencies of a package
npm test # optional
npm 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.
↝ read our guide
To bootstrap a new project you can use the BioJS slush generator.
Publish it on npm and just send us a pull request to the index.toml.