Installing odinson-rest (For Development)

Requirements

• docker
• JDK 11
• sbt
• 2G of RAM

Install

Clone the odinson-rest repository.

Python library

Build

cd python
pip install -e ".[all]"

REST API (Scala)

Build

The project that defines the REST API can be built using either docker or sbt; however, the recommended method is to use docker.

Docker

We construct our docker images using the sbt native-packager plugin:

sbt dockerize

For information on additional tasks (generating Dockerfiles, publishing images, etc.), see this section of the native-packager documentation.

Building docker images for other architectures

sbt ";clean; docker:stage"
cd target/docker/stage
docker buildx build --platform=linux/amd64 -o type=docker -t "lumai/odinson-rest-api:amd64" .

sbt

The REST API server can be launched directly using SBT:

sbt web

Running

To run the Odinson REST API in development mode, run the following command:

sbt web

Open your browser to localhost:9000.