{"id":18666753,"url":"https://github.com/bionode/bionode-template","last_synced_at":"2025-07-04T03:39:49.023Z","repository":{"id":18445064,"uuid":"21635818","full_name":"bionode/bionode-template","owner":"bionode","description":"A base template for quickly creating bionode modules.","archived":false,"fork":false,"pushed_at":"2017-06-01T20:43:46.000Z","size":295,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-06-26T10:53:56.651Z","etag":null,"topics":["bioinformatics","bionode","examples","nodejs"],"latest_commit_sha":null,"homepage":"bionode.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bionode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-09T02:07:24.000Z","updated_at":"2019-08-13T15:45:35.000Z","dependencies_parsed_at":"2022-09-24T09:23:20.857Z","dependency_job_id":null,"html_url":"https://github.com/bionode/bionode-template","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/bionode/bionode-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bionode","download_url":"https://codeload.github.com/bionode/bionode-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263442059,"owners_count":23467212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bioinformatics","bionode","examples","nodejs"],"created_at":"2024-11-07T08:33:58.208Z","updated_at":"2025-07-04T03:39:48.999Z","avatar_url":"https://github.com/bionode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://bionode.io\"\u003e\n    \u003cimg height=\"200\" width=\"200\" title=\"bionode\" alt=\"bionode logo\" src=\"https://rawgithub.com/bionode/bionode/master/docs/bionode-logo.min.svg\"/\u003e\n  \u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"http://bionode.io/\"\u003ebionode.io\u003c/a\u003e\n\u003c/p\u003e\n\n\n# bionode-template\n\n\u003e Template module to use as a base for quickly creating bionode modules.\n\n[![npm](https://img.shields.io/npm/v/bionode-template.svg?style=flat-square)](http://npmjs.org/package/bionode-template)\n[![Travis](https://img.shields.io/travis/bionode/bionode-template.svg?style=flat-square)](https://travis-ci.org/bionode/bionode-template)\n[![Coveralls](https://img.shields.io/coveralls/bionode/bionode-template.svg?style=flat-square)](http://coveralls.io/r/bionode/bionode-template)\n[![Dependencies](http://img.shields.io/david/bionode/bionode-template.svg?style=flat-square)](http://david-dm.org/bionode/bionode-template)\n[![npm](https://img.shields.io/npm/dt/bionode-template.svg?style=flat-square)](https://www.npmjs.com/package/bionode-template)\n[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/bionode/bionode)\n\n\n## Principles\n\nThis 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).\n\nThat is:\n\n* Be small, simple and do one thing well;\n* Use [Node's CommonJS module pattern](http://nodejs.org/docs/latest/api/modules.html) and be available on [NPM](http://npmjs.org);\n* Provide Node.js [Streams](http://nodejs.org/api/stream.html);\n* 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);\n* If possible, work client-side (browser) using [browserify](https://github.com/substack/node-browserify);\n* Provide testing (preferably with [tape](http://github.com/substack/tape) and [testling](https://ci.testling.com));\n* Provide code coverage (preferably with [istanbul](https://github.com/gotwarlost/istanbul));\n* Provide code with comments and documentation (preferably with [docco](https://github.com/jashkenas/docco));\n* [KISS](http://en.wikipedia.org/wiki/KISS_principle) and don't [abuse objects](http://timruffles.github.io/you-probably-dont-want-an-object);\n* Be [MIT](http://choosealicense.com/licenses/mit/) licensed.\n\nTo 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).\n\nThe following sections should be adapted and included in the README.md file.\n\n\n## Install\n\nInstall ```bionode-template``` with [npm](//npmjs.org):\n\n```sh\n$ npm install bionode-template\n```\nTo use it as a command line tool, you can install it globally by adding ```-g``` .\n\nAlternatively, just include `bionode-template.min.js` via a `\u003cscript/\u003e` in your page or use [Browserify](http://browserify.org).\n\nUsage\n-----\n\n You can require the module in Node.js or in a browser:\n\n```js\nvar template = require('bionode-template')\ntemplate.greet('World').on('data', console.log)\n//=\u003e {\"greeting\":\"Hello World\"}\n```\n\nPlease read the [documentation](http://rawgit.com/bionode/bionode-template/master/docs/bionode-template.html) for the methods exposed by bionode-template.\n\n\n### Command line examples\n\n```sh\n$ bionode-template greet World\n$ echo World | bionode-template greet\n```\n\n\n### Usage with [Dat](http://dat-data.com)\n\n```sh\necho World | bionode-template greet | dat import --json\n```\n\n\n## Contributing\n\nWe welcome all kinds of contributions at all levels of experience, please read the [CONTRIBUTING.md](CONTRIBUTING.md) to get started!\n\n\n## Communication channels\n\nDon't be shy! Come talk to us :smiley:\n\n* **Email** [mail@bionode.io](mailto:mail@bionode.io)\n* **Chat room** [http://gitter.im/bionode/bionode-template](http://gitter.im/bionode/bionode-template)\n* **IRC** #bionode on Freenode\n* **Twitter** [@bionode](http://twitter.com/@bionode)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbionode%2Fbionode-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbionode%2Fbionode-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbionode%2Fbionode-template/lists"}