@@ -7,7 +7,8 @@ This page gives insights on extending Aura Engine internals or through the API.
...
@@ -7,7 +7,8 @@ This page gives insights on extending Aura Engine internals or through the API.
-[Aura Engine Development Guide](#aura-engine-development-guide)
-[Aura Engine Development Guide](#aura-engine-development-guide)
-[AURA Componentes](#aura-componentes)
-[AURA Componentes](#aura-componentes)
-[Engine Components](#engine-components)
-[Engine Components](#engine-components)
-[Running Engine for Development](#running-engine-for-development)
-[Running for Development](#running-for-development)
-[Testing](#testing)
-[API](#api)
-[API](#api)
-[Scheduler](#scheduler)
-[Scheduler](#scheduler)
-[Docker](#docker)
-[Docker](#docker)
...
@@ -46,7 +47,7 @@ There's a convenience script to start all of the three main dependencies (Steeri
...
@@ -46,7 +47,7 @@ There's a convenience script to start all of the three main dependencies (Steeri
*...TBD...*
*...TBD...*
## Running Engine for Development
## Running for Development
Ensure you have following other projects up and running:
Ensure you have following other projects up and running:
...
@@ -70,6 +71,14 @@ Now start Liquidsoap which is part of Engine Core:
...
@@ -70,6 +71,14 @@ Now start Liquidsoap which is part of Engine Core:
If your IDE of choice is *Visual Studio Code*, then there are launch settings provided in `.vscode/launch.json`.
If your IDE of choice is *Visual Studio Code*, then there are launch settings provided in `.vscode/launch.json`.
## Testing
Test cases are located in `./tests`. The test command expects a virtual environment in `./python` which gets activated automatically as soon you run the tests with
```shell
~/code/aura/engine$ ./run.sh test
```
## API
## API
You can find the AURA API definition here: https://gitlab.servus.at/autoradio/meta/blob/master/api-definition.md
You can find the AURA API definition here: https://gitlab.servus.at/autoradio/meta/blob/master/api-definition.md