deliver

Prerequisites

To run the application you will need:

A PostgreSQL database
An OpenID Connect endpoint
An S3 compatible object store

Configuration

See here.

Docker Setup

You will need Docker and git to get started

cp docker-compose.example.yml docker-compose.yml
configure the oidc provider
docker compose up

Local development setup with live reload

For local development you will also need:

Go >= 1.20
A recent version of node.js
A recent version of Postgres
An S3 compatible object store

Initial setup:

cp .env.example .env
cp reflex.conf.example reflex.conf
make install-dev

To run the development server:

make dev

Dev Containers

This project supports Dev Containers. Following these steps will auto setup a containerized development environment for this project. In VS Code, you will be able to start a terminal that logs into a Docker container. This will allow you to write and interact with the code inside a self-contained sandbox.

Installing the Dev Containers extension

Open VS Code.
Go to the Dev Containers extension page.
Click the install button to install the extension in VS Code.

Open in Dev Containers

Open the project directory in VS Code.
Click on the green "Open a remote window" button in the lower left window corner.
Choose "reopen in container" from the popup menu.
The green button should now read "Dev Container: App name" when successfully opened.
Open a new terminal in VS Code from the Terminal menu link.

You are now logged into the dev container and ready to develop code, write code, push to git or execute commands.

Run the project

Open a new terminal in VS Code from the Terminal menu link.
Execute this command reflex -d none -c reflex.docker.conf.
Once the application has started, VS Code will show a popup with a link that opens the project in your browser.

Networking

The application and its dependencies run on these ports: