Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.65 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.65 KB
Raw

coepi-backend-aws/api-server

A standalone frontend for the CoEpi Cloud API, suitable for deploying to Kubernetes or any other containerized solution.

Getting Started

Prerequisites:

  • You have run the "Deploy" instructions from the main project README (so that the Dynamo table exists)
  • Your local environment is configured with AWS credentials (so the server can access the Dynamo table)

The API server can be run locally with Gradle:

./gradlew api-server:run

You should now be able to interact with the server through HTTP clients such as curl:

$ curl localhost:8080/v4/tcnreport -d 'SGVsbG8sIHlvdS4='
$ curl localhost:8080/v4/tcnreport
["SGVsbG8sIHlvdS4="]

Deploy

This project uses jib for containerization, which makes it easy to build and deploy images without necessarily needing Docker installed.

Publishing to an Image Repository

To publish to an image repository, use the jib task:

./gradlew api-server:jib -P jib.to.image=YOUR_REPO_NAME/coepi-cloud-api

Running Locally in Docker

Jib can also build an image to your local Docker daemon so you can try it out locally. Note that this requires you have Docker installed on your machine.

./gradlew api-server:jibDockerBuild

This will build an image and tag it coepi-cloud-api. To run locally, you'll need to pass it your AWS credentials:

docker run -p 8080:8080 \
  -e AWS_ACCESS_KEY=<your access key> \
  -e AWS_SECRET_ACCESS_KEY=<your secret access key> \
  -e AWS_REGION=us-west-1 \
  coepi-cloud-api