Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bionode/bionode-template
A base template for quickly creating bionode modules.
https://github.com/bionode/bionode-template
bioinformatics bionode examples nodejs
Last synced: 2 months ago
JSON representation
A base template for quickly creating bionode modules.
- Host: GitHub
- URL: https://github.com/bionode/bionode-template
- Owner: bionode
- License: mit
- Created: 2014-07-09T02:07:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-01T20:43:46.000Z (over 7 years ago)
- Last Synced: 2024-10-05T07:37:24.116Z (3 months ago)
- Topics: bioinformatics, bionode, examples, nodejs
- Language: JavaScript
- Homepage: bionode.io
- Size: 288 KB
- Stars: 8
- Watchers: 23
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# bionode-template
> Template module to use as a base for quickly creating bionode modules.
[](http://npmjs.org/package/bionode-template)
[](https://travis-ci.org/bionode/bionode-template)
[](http://coveralls.io/r/bionode/bionode-template)
[](http://david-dm.org/bionode/bionode-template)
[](https://www.npmjs.com/package/bionode-template)
[](https://gitter.im/bionode/bionode)
## Principles
This provides a quick template to build a bionode module. A bionode module should follow the [Unix philosophy](http://en.wikipedia.org/wiki/Unix_philosophy) and play nice with [Node.js](http://nodejs.org).
That is:
* Be small, simple and do one thing well;
* Use [Node's CommonJS module pattern](http://nodejs.org/docs/latest/api/modules.html) and be available on [NPM](http://npmjs.org);
* Provide Node.js [Streams](http://nodejs.org/api/stream.html);
* Provide a [Command Line Interface](http://en.wikipedia.org/wiki/Command-line_interface) compatible with [Unix pipes](http://en.wikipedia.org/wiki/Pipeline_%28Unix%29);
* If possible, work client-side (browser) using [browserify](https://github.com/substack/node-browserify);
* Provide testing (preferably with [tape](http://github.com/substack/tape) and [testling](https://ci.testling.com));
* Provide code coverage (preferably with [istanbul](https://github.com/gotwarlost/istanbul));
* Provide code with comments and documentation (preferably with [docco](https://github.com/jashkenas/docco));
* [KISS](http://en.wikipedia.org/wiki/KISS_principle) and don't [abuse objects](http://timruffles.github.io/you-probably-dont-want-an-object);
* Be [MIT](http://choosealicense.com/licenses/mit/) licensed.
To try to maximize the compatibility of the new module and anticipate possible use cases, the authors of the new bionode module should be aware of the existing bionode modules and other useful projects like [Dat](http://github.com/maxogden/dat).
The following sections should be adapted and included in the README.md file.
## Install
Install ```bionode-template``` with [npm](//npmjs.org):
```sh
$ npm install bionode-template
```
To use it as a command line tool, you can install it globally by adding ```-g``` .
Alternatively, just include `bionode-template.min.js` via a `` in your page or use [Browserify](http://browserify.org).
Usage
-----
You can require the module in Node.js or in a browser:
```js
var template = require('bionode-template')
template.greet('World').on('data', console.log)
//=> {"greeting":"Hello World"}
```
Please read the [documentation](http://rawgit.com/bionode/bionode-template/master/docs/bionode-template.html) for the methods exposed by bionode-template.
### Command line examples
```sh
$ bionode-template greet World
$ echo World | bionode-template greet
```
### Usage with [Dat](http://dat-data.com)
```sh
echo World | bionode-template greet | dat import --json
```
## Contributing
We welcome all kinds of contributions at all levels of experience, please read the [CONTRIBUTING.md](CONTRIBUTING.md) to get started!
## Communication channels
Don't be shy! Come talk to us :smiley:
* **Email** [[email protected]](mailto:[email protected])
* **Chat room** [http://gitter.im/bionode/bionode-template](http://gitter.im/bionode/bionode-template)
* **IRC** #bionode on Freenode
* **Twitter** [@bionode](http://twitter.com/@bionode)
