@biojs/generator-biojs-webcomponents

This package is deprecated. Use this instead.

generator-biojs-webcomponents

Generates the scaffold for a BioJS component automatically so you don't have to do it yourself.

What this tool currently does

This tool specifically designed with re-packaging existing components in mind, so you can upgrade to BioJS 3 component style without having to re-write your component.

To-do / roadmap.

See issues for more details - we still need the following:

1. Scaffolder for new browser tools (i.e. not just a wrapper for older tools)
2. Scaffolder for command line tools.

Getting started.

First, install Yeoman and generator-biojs-webcomponents using npm (we assume you have pre-installed node.js) - if you need to manage multiple versions of node also consider nvm.

Once node is installed, run this in your terminal.

Note that below you can change my-new-component to the folder name of your choice.

mkdir my-new-component 
cd my-new-component
npm install -g yo @biojs/generator-biojs-webcomponents

Then generate your new project:

yo @biojs/biojs-webcomponents

This will walk you through the process of setting up your component and generate boilerplate files for you. Once it's complete, look at your new README file for build instructions, and check out src/index.js and examples/index.html to get started - there are instructions in the code.

License

MIT © Yo Yehudi