Skip to content
Snippets Groups Projects
Commit 8d9eeb39 authored by David Trattnig's avatar David Trattnig
Browse files

docs: commands as make targets

parent 9dde5dc9
No related branches found
No related tags found
No related merge requests found
......@@ -22,9 +22,9 @@
Aura Engine runs on any modern Debian-based OS. It requires at least
- [Python 3.9+](https://www.python.org/downloads/release/python-380/)
- [`pip`](https://pip.pypa.io/en/stable/)
- [`git`](https://git-scm.com/)
- [Poetry](https://python-poetry.org/)
- [PostgreSQL 13+](https://www.postgresql.org/)
- [`git`](https://git-scm.com/)
**Setting up the project structure**
......@@ -87,42 +87,27 @@ Required modifications are: - The password `db_pass` for the local database hold
## Running Engine
There's a convencience script `run.sh` to get engine started
```shell
engine$ ./run.sh
```
The script executes the _default target_, which is usually `dev` for development environments.
You can call this target explicitly too:
```shell
engine$ ./run.sh dev
```
Or run Engine in production mode:
To start the Engine run:
```shell
engine$ ./run.sh prod
engine$ make run
```
For details on the run script, consult the [AURA CLI documentation](https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/cli.md).
### Starting dependencies
You'll also need to start Engine Core separately.
> Note it should not matter in which order you start Engine and Engine Core.
> Note it should not matter in which order you start Engine and Engine Core. To be on the safe
> site, start Engine Core first.
```shell
engine-core$ ./run.sh
engine-core$ make run
```
Last but not least, Engine API is the target service to store playlogs, health information and details for the [Studio Clock](https://gitlab.servus.at/aura/dashboard-clock).
```shell
engine-api$ ./run.sh
engine-api$ make run
```
In order to have the complete Engine experience, other AURA Components are required to be running too. Checkout the [Meta Repository](https://gitlab.servus.at/aura/meta) on how to run for example AURA Web using Docker Compose.
......
......@@ -56,13 +56,13 @@ The following steps expect you having done the bases configuration and set up a
Start Liquidsoap which is part of Engine Core:
```shell
~/code/aura/engine-core$ ./run.sh
~/code/aura/engine-core$ make run
```
Now run the Engine:
```shell
~/code/aura/engine$ ./run.sh
~/code/aura/engine$ make run
```
If your IDE of choice is _Visual Studio Code_, then there are launch settings provided in `.vscode/launch.json`.
......@@ -72,7 +72,7 @@ If your IDE of choice is _Visual Studio Code_, then there are launch settings pr
Test cases are located in `./tests` are executed by running:
```shell
~/code/aura/engine$ ./run.sh test
~/code/aura/engine$ make test
```
## API
......@@ -149,19 +149,19 @@ point in time and the involved phase before:
Build your own, local Docker image
```shell
./run.sh docker:build
make docker.build
```
Run the locally build image
```shell
./run.sh docker:dev
make docker.run
```
Releasing a new version to DockerHub
```shell
./run.sh docker:push
make docker.push
```
## Read more
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment