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.
Copy file name to clipboardExpand all lines: README.md
+50-3Lines changed: 50 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Generates the scaffold for a BioJS component automatically so you don't have to
5
5
6
6
This tool is specifically designed keeping in mind the idea of re-packaging existing components, so you can upgrade your components to BioJS 3 component style without having to re-write your component.
7
7
8
-
## Getting started.
8
+
## I. Getting started.
9
9
10
10
Step 0: Install [node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/) (npm is distributed with Node.js- which means that when you download Node.js, you automatically get npm installed on your computer).
11
11
@@ -38,7 +38,7 @@ After running this, you will be asked some questions about the details of your p
38
38
Once it's complete, look at your new README file for build instructions, and check out `src/index.js`
39
39
and `examples/index.html` to get started - there are instructions in the code.
40
40
41
-
## Description of your Project's Folder Structure
41
+
## II. Description of your Project's Folder Structure
42
42
Once you complete all the steps mentioned above you will have a project with a folder structure like this -
43
43
44
44
```bash
@@ -85,7 +85,54 @@ Contains instructions for writing description of your component. You should edit
85
85
86
86
Other files are starter files for your project. Generally, you do not need to edit these files.
87
87
88
-
If you face any issue, feel free to contact us at [Gitter](https://gitter.im/yochannah).
88
+
If you face any issue, feel free to contact us at [Gitter](https://gitter.im/biojs).
89
+
90
+
## III. Contribute
91
+
92
+
To contribute, clone this repository, install yeoman and run the code.
Step 5: Go out of the generator's directory. Run and test the generator locally.
127
+
128
+
```bash
129
+
cd ..
130
+
mkdir test-biojs-generator
131
+
cd test-biojs-generator
132
+
yo biojs-webcomponents
133
+
```
134
+
135
+
Note: If you have installed the generator-biojs-webcomponents globally, there is no need to worry, this method will still work. You do not need to uninstall anything.
0 commit comments