broadinstitute/agora

Name: agora

Owner: Broad Institute

Description: It's a methods repository!

Created: 2015-04-28 20:18:52.0

Updated: 2017-10-18 05:51:48.0

Pushed: 2018-01-12 16:11:32.0

Homepage:

Size: 8732

Language: Scala

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Agora

It's a methods repository!

Agora is written in Scala, uses Akka/Spray for its web framework, and is built using SBT.

Building and testing the Agora Web Service

To obtain and build the app, perform the following commands:

ew install git-secrets # if not already installed
t clone https://github.com/broadinstitute/agora.git
 -r hooks/ .git/hooks/ # this step can be skipped if you use the rsync script to spin up locally
mod 755 .git/hooks/apply-git-secrets.sh # this step as well
 agora
t package

You can additionally run unit test through:

t test

Make sure your config file isn't using the actual dev databases…

and integration test using:

t integrationTest

Building with docker

To build the broadinstitute/agora docker image, run

docker/build.sh jar -d build

This builds the agora jar, and copies it into the docker image (see Dockerfile).

Running Your Own Agora Web Service

Assuming you have already built as per the instructions above, create a file called “/etc/agora.conf”, with the appropriate configuration information populated. An example, with defaults, can found in `src/main/resources/reference.conf. Move application.conf to ``src/main/resources/``` Start a mongo database. Finally, run the following command to start the server:

t run

Go to the specified web address in your favorite browser to test that it is operational.

Running Your Own Agora Web Service Using Docker

Generate Agora configurations using the configurations in FireCloud-Develop:

NAME=agora \ 
ENV=dev \
RUN_CONTEXT=local \
INPUT_DIR=$PWD \
OUTPUT_DIR=./config \
../firecloud-develop/configure.rb

Launch the generated docker compose file:

er-compose -p agora -f config/docker-compose.yaml up

or, use the config script:

nfig/docker-rsync-local-agora.sh 

The docker compose configuration is set to point to https://local.broadinstitute.org:30443/ (where the endpoints can be viewed via Swagger).