A modern genome browser built with JavaScript and HTML5.
JavaScript Perl CSS C++ Python HTML Other
Permalink
Failed to load latest commit information.
bin Use env perl for maker2jbrowse Dec 19, 2015
browser Update Menu for electron 1.0 api + use GET instead of POST May 18, 2016
build Bump to 1.1.0 May 18, 2016
css Update seq track to have show colors option Apr 22, 2016
docs Create nonoverlapping bookmarks example on volvox dataset Aug 15, 2016
img Alternative Welcome screen Dec 2, 2015
plugins helps to fix GMOD/Apollo#1417 Jan 7, 2017
sample_data Delete volvox_microarray.wig Dec 19, 2015
src patch for #743 Dec 17, 2016
tests Merge pull request #729 from GMOD/tabix_bed Jul 7, 2016
.bowerrc Use Bower, instead of git submodules, for dependencies. Aug 29, 2013
.gitignore Restore gitignore Jan 12, 2017
.htaccess add a .htaccess file to the JBrowse root directory that enables CORS Nov 29, 2012
.jshintrc Add undef to jshintrc and fix related warnings Dec 3, 2015
.travis.yml Echo build log after failure Mar 24, 2016
INSTALL make INSTALL point at the tutorial again, now that it's updated Apr 4, 2012
LICENSE add license info Jan 14, 2009
Makefile.PL Change authors. Dec 17, 2015
README.md small clarification about electron app Aug 22, 2016
bower.json Fix 'normal is not defined' error on Chrome 51 Jun 7, 2016
compat_121.html Migrate in 1.12.1 release fixes. Mar 21, 2016
index.html Fix head/body declarations in HTML. See #736 May 2, 2016
jbrowse.conf Revert changes to jbrowse.conf Feb 22, 2016
jbrowse_conf.json add an empty jbrowse_conf.json, with a comment Dec 13, 2013
package.json Rename electron-prebuilt to electron http://electron.atom.io/blog/201… Jan 12, 2017
release-notes.txt Update release-notes.txt Jul 7, 2016
setup.sh typo Sep 5, 2016

README.md

Build status

Installing JBrowse

Users of JBrowse should get it from the main JBrowse site at http://jbrowse.org/install.

Unless you intend to work on the JBrowse code itself, or develop a JBrowse plugin, stop reading now and go to http://jbrowse.org/install.

About running from a git clone

Only developers should run JBrowse from a git repository. For one reason, the development version has a much, much slower initial load time than the built release zipfiles. Also, since the master branch code is ''in development'' for the next JBrowse release, it often (usually?) contains bad bugs, much more so than the official releases put up on JBrowse.org.

Setting up a development environment

Make sure you have a web server installed on your development machine. Any web server will do.

cd /my/dev/webserver/root;
git clone https://github.com/GMOD/jbrowse jbrowse 
cd jbrowse
bower --allow-root -f install
./setup.sh
# and now point your browser to
#   http://localhost/jbrowse/index.html?data=sample_data/json/volvox
# and you should see the volvox example data

Then you can simply edit files and your changes will be available in the browser (i.e. no build step is required)

You can also optionally run build steps to create the minimized codebase. Extra dependencies Text::Markdown and DateTime are required to run the build step.

make -f build/Makefile release-notest
make -f build/Makefile release # alternate build with full test suite

To build the Electron app (JBrowse desktop app), run the following

npm install -g electron-packager
make -f build/Makefile release-electron-all

To run the Electron app in debug mode run the following

npm install
npm start

Running the developer test suites

Server-side Perl

Tests for the server-side Perl code. You must have the JBrowse Perl module prerequisites installed for them to work. Run with:

prove -Isrc/perl5 -lr tests

Client-side Unit Tests

Point your browser at http://my.dev.machine/jbrowse/tests/js_tests/index.html

You can also run them from phantomJS using

phantomjs tests/js_tests/run-jasmine.js http://my.dev.machine/jbrowse/tests/js_tests/index.html

Client-side Integration Tests

Integration tests for the client-side app. You need to have Python eggs for selenium and nose installed. Run the tests with:

JBROWSE_URL='http://localhost/jbrowse/index.html' nosetests

Cutting a JBrowse release

  1. Edit the JBrowse package.json file and change 'version' to the version you are releasing. Don't commit this change to the repository, it should stay as dev in git so that it shows up in analytics as a development version.

  2. Build the release packages: make -f build/Makefile release. The files produced during the build should not be committed to the repository either. There is also make -f build/Makefile release-notest for releases that don't need perl tests to be run. NOTE: you may need to use the command ulimit -n 1000 to avoid "spawn EMFILE" build errors.

  3. Make a tag in the repository for the release, named, e.g. 1.6.3-release.

  4. scp the release .zip files (min and full) to jbrowse.org.

  5. Add them to the Wordpress Downloads list so that we can track how many times they are downloaded.

  6. Write a blog post announcing the release. The release-notes.html file made during the build might be useful for this.

  7. Update the "Install" page on the site to point to the newest release.

  8. Update the latest-release code checkout on the site, which the "Latest Release" demo on the jbrowse.org points to, to be an unzipped-and-set-up copy of the latest release.

  9. Write an email announcing the release, sending to gmod-ajax, jbrowse-dev. If it is a major release, add gmod-announce and make a GMOD news item.

As you can tell, this process could really use some more streamlining and automation.