https://github.com/intermine/bluegenesprotvista
wrapper around the uniprot protvista protein feature viewer
https://github.com/intermine/bluegenesprotvista
bluegenes-tool
Last synced: 1 day ago
JSON representation
wrapper around the uniprot protvista protein feature viewer
- Host: GitHub
- URL: https://github.com/intermine/bluegenesprotvista
- Owner: intermine
- Created: 2018-08-17T15:01:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-10T15:38:51.000Z (almost 5 years ago)
- Last Synced: 2025-06-17T19:47:40.550Z (1 day ago)
- Topics: bluegenes-tool
- Language: HTML
- Homepage:
- Size: 252 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bluegenesProtVista
Wrapper around the uniprot protvista protein feature viewer
This is a prototype tool for the BlueGenes Tool API, and roughly fits the expected format of BlueGenes tool API behaviour. It is based on [this spec](https://gist.github.com/yochannah/69ab9d1fd9721cb9a701805832c39937).
### Note the following
- **config.json** is read by BlueGenes to allow BlueGenes to know what type of data the tool supports.
- **preview.png** is optional, but will be used in the longer term in a tool admin UI to allow people to enable / disable / configure tools.
- **package.json** is the default npm config but it also used by bluegenes to glean information like the script entry point (main), tool name and the tool's dependencies.
- `dependencies` will be automatically installed by bluegenes
- `devDependencies` will not be automatically installed and may be items like imtables (which bluegenes will provide on the window) or jquery. (versions to be confirmed).
- **src/index.js** is the important part - the visualiser is initialised here. Note the method name matches the package name, and note the method signature - this is what all tools will expect to receive from bluegenes
- **demo.html** has comments explaining what's going on, too, but is mostly there so people can see what the vis looks like as part of a standalone package. It is optional.
### To set up locally for development
1. Clone the repo
2. `cd bluegenesProtVista` 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:
#### 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
```
##### Dev build that auto-rebuilds saved files:
Note that you'll still have to serve and refresh the page yourself - we don't provide a built-in hot-reload server.
```
npm run dev
```