Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yochannah/biojs-webcomponent-prototype

prototyping webcomponents for biojs at the Biohackathon 2018 Japan
https://github.com/yochannah/biojs-webcomponent-prototype

Last synced: about 2 months ago
JSON representation

prototyping webcomponents for biojs at the Biohackathon 2018 Japan

Awesome Lists containing this project

README

        

## To use this component on your site
Quickstart: There's a demo in [index.html](index.html).

Longer:

### In the ``, add:
```html

```

This links to the relevant scripts to define the component and fetch data.

### In the ``

Where you want your webcomponent to appear, add the following:

```html


```

Some notes on usage:

- `intermineService` value must point to the webservices
from an InterMine. for a full list of InterMines, see registry.intermine.org.
e.g. if you are interested in rat data, set ratmine to be the url,
or for plants you might want legumemine or phytomine.
- `searchOrganism` The format for the organism name must be in abbreviated format - e.g.
D. melanogaster works, Drosophila melanogaster would not.
- `searchTerm` - must be an identifier for a Gene or Protein
- `searchClass` - choose either Gene or Protein. (Case matters)

## Developing:

### Prerequisites:

[npm 6+](https://www.npmjs.com/), ideally installed via [nvm](https://github.com/creationix/nvm).

### Install
Once this repo is cloned, in your terminal, run:

```bash
npm install
```

### To build js

In your terminal, run

```bash
npx webpack
```

### Developer notes

This uses [hybrids.js](https://github.com/hybridsjs/hybrids) to implement webcomponents easily.