Commit 643df1d8 authored by Andrea Ida Malkah Klaura's avatar Andrea Ida Malkah Klaura
Browse files

updated README.md

parent bfbd1de7
......@@ -4,7 +4,7 @@
## Prerequisites
This version is an early development prototype, only the interface to the [steering/pv module](https://gitlab.servus.at/autoradio/pv) is implemented partly yet. And it uses its own dummy REST API, based on a JSON Server. You have to set up the current [dummy-api-json-server](https://gitlab.servus.at/autoradio/dummy-api-json-server) first, if you want this demo to run out of the box.
This version is an early development prototype, only the interface to the [steering/pv module](https://gitlab.servus.at/autoradio/pv) is implemented partly yet.
## Build Setup
......@@ -33,6 +33,20 @@ npm run e2e
npm test
```
## Configuration of the steering/pv backend
For the dashboard to run in a dev mode you only need the `npm install` and `npm run dev` commands. To access show data in the show manager you also have to have the [steering/pv module](https://gitlab.servus.at/autoradio/pv) running somewhere. There you need to add the following lines to the `pv/local_settings.py`, in order to allow CORS requests from you dashboard:
```
CORS_ALLOW_CREDENTIALS = True
CORS_ORIGIN_WHITELIST = (
'localhost:8080'
)
```
This assumes of course that you have the dashboard running on its standard localhost port 8080. If you want to change this to e.g. port `9090`, add a line `PORT: 9090,` to the `module.exports` in `config/dev.env.js` file of the dashboard package.
## Detailed infos on build environment
This project is built with [Vue.js 2](https://vuejs.org). Take a look at their [Guide](https://vuejs.org/v2/guide/) or the [API docs](https://vuejs.org/v2/api/) to find out more about the core framework. As template we are using the _webpack template_. For a detailed explanation on how things work with this, check out the [webpack guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
......
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