Program access - ActiveDataBio/adbio_tutorial GitHub Wiki

#Using Adbio

##Host The host of Adbio is a user role that is responsible for setting up the repo.properties file and running the server. There are a couple of ways to run the server. The first is using docker, the other is cloning the Adbio repository.(link coming soon)

###Configuration First explaining the repo.properties file. This is a java properties file with json text that contains the configuration for the projects the host wishes to deploy with the server.

repo={"host":"https://github.com"\,"repos":["ActiveDataBio/ADB-User-Study.git"\,"ActiveDataBio/Prochlorococcus.git"]\, "api":"https://api.github.com"}

Each git host will need a line starting with repo. The json has 3 properties host,repos, and api. The host is git host(e.g. github.com, bitbucket.com), repos is an array of strings that represent the path to the git file for the repository. Api is how to access the api for the git host.

###Run The first method for running the Adbio is to use Docker. This requires Windows version greater than 7, Linux, or IOS.

  • Download and Install Docker
  • Download the Adbio Docker image(link coming soon)

From the command line run: (subject to change)

docker build <path to docker image>
docker run -p 8080:8080 -v <path to repo.properties>:/repo.properties -t springio/adbio-docker

once finished use a web browser to connect to the server with localhost:8080 in the address bar or from another computer with <computer name and domain or ip of host computer>:8080

The other method is the same procedure as a developer ##Developer The developer will contribute to the code base creating new and interesting visualizations, making the program faster, or in general making the code better. To develop there are a few things that need to be downloaded and installed before we start.

Next we need to setup the environment and import the project to STS.
After loading STS -> click file -> click import -> choose Gradle (STS) Project -> click next -> choose the root folder that you placed Adbio repository -> click build model, after that the project should be populated and selected, finally click finish.

To run click the play button on the tool bar -> select java application -> select AdbioSpringBootApplication - com.pnnl.adbio -> click ok
After the first time clicking the play button the server will start without any additional steps.

To access the server use a web browser with localhost:8080 in the address bar. Others on the same network can access by using <computer name and domain or ip of host computer>:8080.