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

Improved doc.

parent 2f4ac9ad
No related branches found
No related tags found
No related merge requests found
...@@ -37,7 +37,34 @@ To run the API in an local development server execute: ...@@ -37,7 +37,34 @@ To run the API in an local development server execute:
./run.sh api-dev ./run.sh api-dev
``` ```
You can access the interactive documentation here: ## Running with Docker
To run the server on a Docker container, please execute the following from the root directory:
```bash
# Building the image
./run.sh docker:build
# Push the current image to dockerhub.com
./run.sh docker:push
# Starting up a container
./run.sh docker:api
```
## Using the API
Adding some entry to the playlog:
```bash
curl -d '{ "track_start": "2020-06-25 15:38:44", "track_artist": "Aphex Twin", "track_title": "Windowlicker", "log_source": 1 }' -H "Content-Type: application/json" -X POST http://localhost:8008/api/v1/playlog/store
```
The attribute `log_source` is a numeric presentation of the engine (`1` or `2`) where this log entry
is coming from. If you are using additional audio sources, such as automated music player, you can
define your own numeric id for such device.
All other API endpoints are listed in the interactive documentation:
```bash ```bash
http://localhost:8008/api/v1/ui/ http://localhost:8008/api/v1/ui/
...@@ -58,17 +85,4 @@ sudo pip install tox ...@@ -58,17 +85,4 @@ sudo pip install tox
./run.sh test ./run.sh test
``` ```
## Running with Docker > Note, the test-cases are currently not functional.
To run the server on a Docker container, please execute the following from the root directory:
```bash
# Building the image
./run.sh docker:build
# Push the current image to dockerhub.com
./run.sh docker:push
# Starting up a container
./run.sh docker:api
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment