Skip to content
forked from GMOD/Apollo

Genome annotation editor with a Java Server backend and a Javascript client that runs in a web browser as a JBrowse plugin.

License

Notifications You must be signed in to change notification settings

boob-sbcm/Apollo

 
 

Repository files navigation

Apollo

DOI Build Coverage Documentation Chat at Gitter

An instantaneous, collaborative, genome annotation editor. The stack is a Java web application / database backend and a Javascript client that runs in a web browser as a JBrowse plugin.

For general information on Apollo, go to http://genomearchitect.org/.

Complete Apollo installation and configuration instructions are available from the Apollo documentation pages

The Apollo client is implemented as a plugin for JBrowse. Additional JBrowse plugins may be found in the JBrowse registry and configured in apollo-config.groovy.

Setup guide

Setup guide for deploying on production and custom configuration guide.
Launchable public Amazon EC2 images may also be found in most regions under the name 'Apollo' as well as instructions for docker.

The quick-start guide for developers shows how to easily get started with Apollo.

Migrating data from older versions

You can follow steps in our migration guide to move annotations and data from older versions.

Note about data directories

Apollo 2.0 allows you to add multiple data directories to your webapp, and it expects the data directories to be stored outside of the tomcat webapps directory. Use the WA2.0 quick-start guide to learn how to add new data directories for your organisms.

Important Note: All data from a webapps directory will disappear when doing tomcat "undeploy" operations, even if it is a symlink..

Launch Apollo in a temporary server

To launch Apollo with temporary settings, use the apollo run-local command, which will initialize your server automatically with an H2 (zero-configuration) database.

apollo run-local 8080

It will also use your custom settings if an apollo-config.groovy file has been setup.

Generate a war file

Users can generate a war file (for example target/apollo-1.0.2.war) that will be copied into their tomcat webapps directory for production deployments:

apollo deploy 

Note: make sure to create an apollo-config.groovy file following the sample data (e.g. sample-postgres-apollo-config.groovy) to make sure you use your preferred database settings.

Run locally for GWT development

apollo devmode 

Thanks to

IntelliJ

YourKit

Thanks to YourKit for providing us the use of their YourKit Java Profiler. YourKit supports Open Source.

About

Genome annotation editor with a Java Server backend and a Javascript client that runs in a web browser as a JBrowse plugin.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Groovy 55.5%
  • JavaScript 30.9%
  • Java 9.6%
  • CSS 2.3%
  • Perl 1.1%
  • Shell 0.4%
  • Other 0.2%