https://github.com/intermine/identifiers-widget
embeddable js widget to display identifiers.org info on your page
https://github.com/intermine/identifiers-widget
Last synced: 3 months ago
JSON representation
embeddable js widget to display identifiers.org info on your page
- Host: GitHub
- URL: https://github.com/intermine/identifiers-widget
- Owner: intermine
- License: other
- Created: 2019-11-20T09:32:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T01:17:23.000Z (about 3 years ago)
- Last Synced: 2025-01-19T18:52:38.345Z (12 months ago)
- Language: JavaScript
- Homepage: http://intermine.org/identifiers-widget/
- Size: 1.23 MB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Identifiers Widget
Widget to load identifiers from identifiers.org and display embedded in your webpage.
## 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:
### 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:
- 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 element like any other HTML element wherever you want.
- `attribute` must be a valid identifier with a valid `value`.
## License
Apache - see [LICENSE](LICENSE)
## Developer docs
### To set up locally for development
1. Clone the repo
2. `cd identifiers-widget` and then `npm install` to 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:
#### CSS
Assuming [less](http://lesscss.org/) is installed globally:
```
npm run less
```
#### JS
Assuming [webpack](https://webpack.js.org/) is installed globally:
##### Single build:
```
npm run build
```
##### Developing:
Run each of these commands in separate terminals:
To rebuild your js every time you save:
```bash
npm run dev
```
To serve your page at [http://localhost:3456](http://localhost:3456):
```bash
npm run server
```