Setting up a Development Environment

For local development, we recommend the native installation as outlined in the README of individual repositories.

Docker Compose Deployments

For production we highly recommend to run AURA using Docker and Docker Compose as outlined in the Administration Guide. But also as a developer you can benefit from the ease of an Docker Compose installation. For example when developing some Engine feature, you may want to run AURA Web or some services with Docker Compose while testing.

Prepare your Development Environment

It is recommended to clone all projects for example in such folder structure:

~code/aura/aura
~code/aura/steering
~code/aura/can
~code/aura/dashboard
~code/aura/dashboard-clock
~code/aura/battery
~code/aura/engine
~code/aura/engine-api
~code/aura/engine-core
...

Order of configuration

After that, you need to configure the projects in following order:

Web Projects

  1. Steering - Administration interface for schedules and program information.

  2. Can - HTTP message proxy for the NATS messaging system.

  3. Dashboard - Frontend to manage schedules, program info and audio files.

  4. Dashboard Clock - Studio clock dashboard.

  5. Battery - Upload, pre-processing and storage of the audio files.

Play-out Projects

  1. Engine Core - Playout-engine to deliver the actual radio to the audience.

  2. Engine API - API Server to provide playlogs and information for the studio clock.

  3. Engine - Scheduling and remote control for the playout-

  4. Engine Recorder - Audio block recording.