Deployment

Clone the repository

SBOS is managed as a mono-repo. Clone the repository and work in the project directory.

git clone https://github.com/BrickSchema/playground
cd projects/sbos-playground

Configuration

Playground can be configured with various options. Please follow this guide to configure it.

Deploy the server

Docker Compose (recommended)Direct

In the playground directory (projects/sbos-playground), run

docker-compose up --build -d # (1)!

1. make sure the context is correct if not using docker-compose but docker build and make sure the docker-compose version is at least v2

In development mode, run

docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d --build

(Not yet completed)

The project is managed by poetry and poe.

poetry install
poe 

Then, open http://localhost:9000/brickapi/v1/docs. If the swagger API page is shown, congratulations! Now you can move to the next step in initialize playground.