search

PheMA / phema-workbench-api

The JAVA API for the PhEMA Workbench.
http://projectphema.org
Apache License 2.0
2 stars 1 forks source link

readme





PhEMA Workbench API

PhEMA Build Status Docker Image

Java API for the PhEMA Workbench.

Quickstart

To get started fast, download the latest version on the releases page, then run:

java -jar phema-workbench-api.jar

You can also run the Docker image using the version shown in the badge above, for example:

docker run -p 8083:8083 phema/phema-workbench-api

To use the PhEMA Workbench application, you will also need to run the app.

Requirements

In order to run the application, you need at least Java 11 installed. To install Java manually, see the documentation here.

Contributing

Technologies

The PhEMA Workbench API is built using the following technologies:

Workflow

1. Clone the repo

git clone https://github.com/phema/phema-workbench-api.git && cd phema-workbench-api

2. Run API

As a developer, you may want to run the API using your IDE, but it is also possible to do so in the terminal by running the following:

mvn exec:java

3. Build Release

When you're done making your changes, you can build a new fat jar by running:

mvn package

This will create target/phema-workbench-api.jar, which will contain all the dependencies and can be run as described in the QuickStart section above.

Deployment

To publish a new Docker image, push a new tag to the repo.

Acknowledgements

This work has been funded by NIGMS grant R01GM105688.

License

Apache 2.0