/jbrowse-components

Monorepo with JBrowse 2 web, JBrowse 2 desktop, the JB core package, core plugins, and more.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Build Status Coverage Status Contributor Covenant

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/

Pre-requisites

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

Either cd to products/jbrowse-web or products/jbrowse-desktop and run yarn start.