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

Pre-requisites

• git
• nodejs (node 18 or greater)
• yarn

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 python 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

git clone https://github.com/GMOD/jbrowse-components.git
cd jbrowse-components
yarn

Install (Windows)

# 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

cd products/jbrowse-web
yarn start

For jbrowse-desktop, launch two tabs

# 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

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/