Commit 4b63df0c authored by David Trattnig's avatar David Trattnig
Browse files

Docs: Some final consolidations

parent d4e97c36
......@@ -14,41 +14,14 @@
[![Documentation Status](https://readthedocs.org/projects/aura-automated-radio/badge/?version=latest)](https://aura-automated-radio.readthedocs.io/en/latest/?badge=latest) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
# AURA - Automated Radio
# META Automated Radio
This repository holds:
## Architecural principles
Some of our core organisational and architectural requirements for _AuRa_ are:
* **Modular architecture**: the whole suite should be made up of modular components which could be exchanged with other custom components
* **Transparent API**: every component shall provide a well-documented API through which other components can interact with it, ideally as a REST API
* **Reuse of existing components**: we do not want to reinvent the wheel. Several stations already developed single components as free software and we can adapt and build on those
* **Modern frameworks**: we do not code from scratch but use modern application development frameworks which provide maintainability as well as security
If you are interested in more technical details, check out the [Developer Guide](docs/development/index.md)
## Component spaces
So we have two *component spaces* for our architecture. Each space defines the nature of the components it holds
* **AURA Web** - Holds all the web applications, data store and media management
* [Steering](https://gitlab.servus.at/aura/steering) - this is the scheduling module, where the actual program schedule of the whole station is stored as well as all infos regarding single shows and emissions. This module mainly acts as the administration interface, while most users will use *Dashboard* to get their work done.
* [Tank](https://gitlab.servus.at/aura/tank) - just spleen without steam. Our tank is an importer module that is used to upload preprocessed emissions (audio data) and to streamline all audio so our _engine_ gets only the good stuff to power our radio channels. The module talks to *Steering* via OpenID to retrieves the current schedules. Additionally it delivers audio to the *Engine*.
* [Dashboard](https://gitlab.servus.at/aura/dashboard) - this is the frontend, were we get a good look on our shows and files to play. The interface aims for a simple experience and allows hundreds of people collaborating within the radio station. The module talks to *Steering* and *Tank* via OpenID, to retrieve program information as well as uploading audio files. Note the *Dashboard* itself has no data-store.
* [Dashboard Clock](https://gitlab.servus.at/aura/dashboard-clock) - A modern studio clock.
* **AURA Play-out** - Everything what's needed to turn data into sound
* [Engine](https://gitlab.servus.at/aura/engine) - the place where the actual scheduling happens. A remote control for Engine Core.
* [Engine Core](https://gitlab.servus.at/aura/engine) - this is where the schedule is actually translated into some stream of sound, our play-out server. It is responsible for playing the right audio at the planned times.
* [Engine API](https://gitlab.servus.at/aura/engine) - this is where the schedule is actually translated into some stream of sound, our play-out server. It is responsible for playing the right audio at the planned times.
- The Docker Compose bundles for AURA Web and AURA Playout, located in `docker-compose`
- Media assets to be used in various parts of the project, located in `assets`
- Presentation about AURA, located in `presentations`
- The complete documentation, located in `docs`
## Getting started
......
......@@ -5,9 +5,9 @@
Automated Radio, AutoRadio, AuRa or AURA, follows an "*Automobile-naming-scheme*". All the components are named after some crucial parts of a car:
- **Steering**: This is the single source of thruth, holding all the data and steering some radios broadcast.
- **Tank**: That's where your shows, tunes and recordings are mangaged. Fuelling your broadcast with materials.
- **Dashboard**: See and control what's happening. The user interface of your radio with individual views for hosts and programme coordinators.
- **Steering**: This is the single source of thruth, holding all the radio data, hence steering some radio's channels.
- **Tank**: Just spleen without steam. That's where your shows, tunes and recordings are mangaged. Fuelling your broadcast with materials.
- **Dashboard**: Observe and control what's happening. The user interface of your radio with individual views for hosts and programme coordinators.
- **Engine**: The playout server allowing you to broadcast via FM and web audio streams. Includes silence detection and optional recording options.
- **Player**: Every modern car has some fancy *Auto Radio Player*. And every radio station has the need for some modern frontend experience. Player is a library of web components. Making web development just like *playing with blocks*.
......@@ -32,4 +32,4 @@ The aforementioned naming scheme, is used as a basis for name-spacing services:
| engine | `x` | Control and scheduling for the play-out |
| engine-core | `x` | Play-out Engine |
| engine-api | | API for playlogs and track service |
| player | | Library for building frontend based on web components |
\ No newline at end of file
| player | | Library for building frontend based on web components |
......@@ -3,10 +3,10 @@
## Code of Conduct
We inherit the [Contributor Covenant](code_of_conduct.md).
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
We inherit the [Contributor Covenant](code_of_conduct.md).
## How can I contribute?
You don't need to be a developer to contribute to the project.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment