https://github.com/intermine/bluegenes-protein-visualizer
https://github.com/intermine/bluegenes-protein-visualizer
bluegenes-tool
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/intermine/bluegenes-protein-visualizer
- Owner: intermine
- License: mit
- Created: 2019-06-03T15:27:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-11T10:01:18.000Z (about 4 years ago)
- Last Synced: 2024-10-14T08:54:27.191Z (8 months ago)
- Topics: bluegenes-tool
- Language: JavaScript
- Homepage:
- Size: 393 KB
- Stars: 0
- Watchers: 12
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BlueGenes Protein Visualizer
BlueGenes Protein Visualizer is a tool made for [BlueGenes](http://bluegenes.apps.intermine.org) following BlueGenes Tool API. It can help users (biologists) to visualize protein structures in different types of viewer in 3D. Users can select the PDB id they want to visualize and the visualizer fetches PDBs from the [rcsb org](https://www.rcsb.org/).
It can also be used as standalone tool to integrate in any web application.
## Licence
MIT
### To set up locally for development
1. Clone the repo
2. `cd bluegenes-protein-visualizer` 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
```
##### Applied Coding practices / ESLint Rules:
- _indent_: use __tab (2 space tab)__ instead of spaces to not get an error.
- _linebreak-style_: use __\n__ for a newline, if you're on windows, configure it in your editor settings.
- _quotes_: use __single quote__ instead of double quote.
- _semi_: use _semi colon_ at end of each statement / expression / function definition.
- _comma-dangle_: do not use dangling commas i.e. extra comma at the end of object values, function args, etc.). More about this [here](https://eslint.org/docs/rules/comma-dangle).
- More pre-configured rules from __eslint:recommended__ you must follow to not get errors [here](https://eslint.org/docs/rules/).
##### Developing:
To serve your code at [localhost:3456](http://localhost:3456) and rebuild it every time it changes, run:
```bash
npm run dev
```