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 d8i"
88888888P" 88 `"YbbdP"' "Y8888P" "Y88888P" 88888888888
TL;DR: you can browse the registry at biojs.net.
Guy Yachdav, Tatyana Goldberg, Sebastian Wilzbach, David Dao, Iris Shih, Saket Choudhary, Steve Crouch, Max Franz, Alexander GarcĂa, Leyla J GarcĂa, Björn A GrĂĽning, Devasena Inupakutika, Ian Sillitoe, Anil S Thanki, Bruno Vieira, JosĂ© M Villaveces, Maria V Schneider, Suzanna Lewis, Steve Pettifer, Burkhard Rost, and Manuel Corpas
[Anatomy of BioJS, an open source community for the life sciences][BioJS-elife]
eLife 2015;4:e07009
[BioJS-elife]: http://elifesciences.org/content/4/e07009
- Essentials
1.1. Objectives
1.2. What is BioJS
1.3. Why is there nothing in this repo?
- Packages
2.1. What is a package?
2.2. How to search for a package - Developing packages
3.1. What do I need to develop?
3.2. How to create a package?
3.3. How to use snippets/examples?
3.4. Guidelines
3.5 I need the functionality X
3.6. Gold standards
3.7. How to publish a package? - Support
4.1 Get involved
4.2. Contact
4.3. More questions?
4.4. Documentation - License
- Essentials
- Represent consistently biological information across different projects
- Ease discovery, test and integration of graphical components
- Standardize and facilitate components development
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.
- Packages
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.
Visit the biojs.net registry to search for components.
(Find it on github: Frontend repo, backend repo).
- Developing packages
Detailed installation instructions.
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-biojs
mkdir biojsAWesome && cd biojsAwesome
slush biojs
↝ read our sniper.
- Events (Convention for the Observer pattern)
- CSS dependencies
- JS dependencies (=npm packages)
- Reusable modules
- example snippets
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.
↝ Learn more
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.
↝ Learn more
We'd recommend opening an issue in their repository directly.
- Support
Whether you want to write your own component and just submit it onto our BioJS registry or help to increase our ecosystem - we value your contribution(s)!
↝ Get involved
Here are some general ideas:
- Browse our issue list
- Ask on gitter
↝ more information
↝ There are many ways to contact us
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.
Contents:
- License