FIXME: fill out a description of your tool here! :)
Component user docs: adding this component to your webpage
Hey! If you'd like to use this component on your webpage, please do the following:
<!-- the library for the webcomponent --> <script src="dist/bundle.js" type="module"></script>
This links to the relevant scripts to define the component and fetch data.
Where you want your WebComponent to appear, add the following:
<complex-viewer geneId="BRCA1"> </complex-viewer>
Some notes on usage:
- Download the bundle.js file from dist folder and link it to your index.html file.
- You may use the style.css in dist folder file for styling the component.
- Use the <complex-viewer element like any other HTML element wherever you want.
attributemust be a valid identifier with a valid
To set up locally for development
- Clone the repo
cd complex-viewerand then
npm installto install dependencies.
All of the editable source files for css and js are in
src. To bundle for prod, run the following commands in the given order:
Assuming less is installed globally:
npm run less
Assuming webpack is installed globally:
npm run build
Run each of these commands in separate terminals:
To rebuild your js every time you save:
npm run dev
To serve your page at http://localhost:3456:
npm run server
To see a demo component implemented similarly to this component, visit biojs-webcomponent-prototype.