You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 30, 2021. It is now read-only.
> Generate the scaffold for a BioJS component automatically so you don't hav to do it yourself
2
+
Generates the scaffold for a BioJS component automatically so you don't have to do it yourself. This is also 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.
3
3
4
-
## Installation
5
4
6
-
First, install [Yeoman](http://yeoman.io) and generator-biojs-webcomponents using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
5
+
6
+
## Getting started.
7
+
8
+
First, install [Yeoman](http://yeoman.io) and generator-biojs-webcomponents using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)) - if you need to manage multiple versions of node also consider [nvm](https://github.com/creationix/nvm).
9
+
10
+
Once node is installed, run this in your terminal.
11
+
12
+
Note that below you can change my-new-component to the folder name of your choice.
7
13
8
14
```bash
9
-
npm install -g yo
10
-
npm install -g generator-biojs-webcomponents
15
+
mkdir my-new-component
16
+
cd my-new-component
17
+
npm install -g yo @biojs/generator-biojs-webcomponents
11
18
```
12
19
13
20
Then generate your new project:
@@ -16,17 +23,17 @@ Then generate your new project:
16
23
yo @biojs/biojs-webcomponents
17
24
```
18
25
19
-
## Getting To Know Yeoman
26
+
This will walk you through the process of setting up your component and generate boilerplate files for you.
27
+
Once it's complete, look at your new README file for build instructions, and check out `src/index.js`
28
+
and `examples/index.html` to get started - there are instructions in the code.
20
29
21
-
* Feel free to [learn more about Yeoman](http://yeoman.io/).
0 commit comments