https://github.com/gmod/jbrowse-components
Source code for JBrowse 2, a modern React-based genome browser
https://github.com/gmod/jbrowse-components
bioinformatics genomics jbrowse visualization
Last synced: 23 days ago
JSON representation
Source code for JBrowse 2, a modern React-based genome browser
- Host: GitHub
- URL: https://github.com/gmod/jbrowse-components
- Owner: GMOD
- License: apache-2.0
- Created: 2018-10-05T17:14:00.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-13T20:06:58.000Z (about 2 months ago)
- Last Synced: 2025-04-13T20:37:25.320Z (about 2 months ago)
- Topics: bioinformatics, genomics, jbrowse, visualization
- Language: TypeScript
- Homepage: https://jbrowse.org/jb2
- Size: 212 MB
- Stars: 231
- Watchers: 21
- Forks: 65
- Open Issues: 286
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/GMOD/jbrowse-components/actions)
[](https://codecov.io/gh/GMOD/jbrowse-components/branch/main)
[](CODE_OF_CONDUCT.md)
# jbrowse-components
Monorepo using Lerna and Yarn workspaces containing many related packages for
next-generation JBrowse development.
Homepage https://jbrowse.org/jb2
Docs http://jbrowse.org/jb2/docs/
Fall 2023: New outreach! We created an "office hours" Google Calendar for anyone
to schedule 1-on-1 meetings with the development team. Details below:
- [Schedule 1-on-1 appointment](https://calendar.app.google/1AYZkNCQNmwdY2R26)
## Pre-requisites
- [git](https://git-scm.com/downloads)
- [nodejs](https://nodejs.org/en/download/) (node 18 or greater)
- [yarn](https://yarnpkg.com/en/docs/install)
You may need additional pre-requisites on certain versions of nodejs.
On macOS with homebrew:
brew install pkg-config cairo pango libpng jpeg giflib librsvg
On Ubuntu, with apt:
sudo apt install -y python3 make gcc libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
## Install (Linux/Mac)
Simply clone the git repo and run yarn in the root repository
```sh
git clone https://github.com/GMOD/jbrowse-components.git
cd jbrowse-components
yarn
```
## Install (Windows)
```pwsh
# Make sure you check out line-endings as-is by running
# `git config --global core.autocrlf false`
# Also, make sure symlinks are enabled by running
# `git config --global core.symlinks true`.
# You may also need to clone as an administrator for symlinks to work.
git clone -c core.symlinks=true https://github.com/GMOD/jbrowse-components.git
cd .\jbrowse-components\
yarn
```
## Quick start for developers
You can use these commands to help get started with your development environment
For running jbrowse-web
```sh
cd products/jbrowse-web
yarn start
```
For jbrowse-desktop, launch two tabs
```sh
# starts webpack dev server
cd products/jbrowse-desktop
yarn start
# starts electron window
cd products/jbrowse-desktop
yarn electron
```
For running e.g. jbrowse-react-linear-genome-view you can use storybook
```sh
cd products/jbrowse-react-linear-genome-view
yarn storybook
```
See CONTRIBUTING.md for more info
If you are installing JBrowse on your server, check out our quick start guides
here https://jbrowse.org/jb2/docs/