https://github.com/intermine/bluegenes-jbrowse-tool
https://github.com/intermine/bluegenes-jbrowse-tool
bluegenes-tool
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/intermine/bluegenes-jbrowse-tool
- Owner: intermine
- License: mit
- Created: 2020-07-15T18:39:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T16:53:32.000Z (about 4 years ago)
- Last Synced: 2025-01-19T18:52:46.288Z (5 months ago)
- Topics: bluegenes-tool
- Language: JavaScript
- Homepage:
- Size: 146 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bluegenes JBrowse Tool
Bluegenes JBrowse Tool is a tool made for [BlueGenes](http://bluegenes.apps.intermine.org) following BlueGenes Tool API.
Add more description of your tool here! :)
## Licence
### To set up locally for development
1. Clone the repo
2. `cd bluegenes-jbrowse-tool` 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
```