Commit 34b66db6 authored by jackie / Andrea Ida Malkah Klaura's avatar jackie / Andrea Ida Malkah Klaura
Browse files

META: update README.md and create sample.env.*

parent 234f20ab
......@@ -2,9 +2,8 @@
node_modules
/dist
# local env files
.env.local
.env.*.local
# all dev/prod specific env files; we have sample.env.* as templates
.env.*
# Log files
npm-debug.log*
......
......@@ -2,13 +2,15 @@
> The Web-UI component of the AUTOradio framework
# Setup
## 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.
This version is an early development prototype.
## Build Setup
Detailed setup infos will follow, as soon as we reach something between alpha and beta stage.
For the current early dev prototype you only need the first two steps here:
## Running it locally (dev environment)
``` bash
## Project setup
......@@ -16,18 +18,19 @@ npm install
### Compiles and hot-reloads for development
npm run serve
```
### Compiles and minifies for production
npm run build
Before you can actually run it, you have to copy the `sample.env.development` file to `.env.development` and change the values to reflect your local setup.
### Run your tests
npm run test
For customizing the whole vue cli development environment, see [Configuration Reference](https://cli.vuejs.org/config/).
### Lints and fixes files
npm run lint
```
## Setting it up on a server (production environment)
For customizing the whole vue cli development environment, see [Configuration Reference](https://cli.vuejs.org/config/).
To build the production code, use `npm run build`. This compiles and minifies the code for production. Then you just have to put it on some static website.
Before building you have to copy the `sample.env.production` file to `.env.production` and change the values to your final setup.
> TODO: provide an example setup
## Configuration
......@@ -52,7 +55,7 @@ CORS_ORIGIN_WHITELIST = (
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 `.env.development` file of the dashboard package.
## Detailed infos on build environment
# 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). For the whole einvornment setup we started out with Vue CLI 2 but now work with [Vue CLI 3](https://cli.vuejs.org).
......
# For detailed comments take a look at the sample.env.production
# Here we filled in some common defaults for local development
# API URLs for the other AuRa modules
# ===================================
VUE_APP_API_STEERING = http://127.0.0.1:8000/api/v1/
VUE_APP_API_STEERING_SHOWS = http://127.0.0.1:8000/api/v1/shows/
VUE_APP_API_TANK = http://127.0.0.1:4000/api/v1/
VUE_APP_OIDC_CLIENT_ID = 078036
# OIDC settings
# =============
# The client ID will most certainly differ for every local dev environment:
VUE_APP_OIDC_CLIENT_ID = 575513
VUE_APP_API_STEERING_OIDC_URI = http://localhost:8000/openid
VUE_APP_API_STEERING_OIDC_EXPIRE_NOTIFICATION = 120
VUE_APP_API_STEERING_OIDC_REDIRECT_URI = http://localhost:8080/oidc_callback.html
VUE_APP_API_STEERING_OIDC_REDIRECT_URI_SILENT = http://localhost:8080/oidc_callback_silentRenew.html
VUE_APP_API_STEERING_OIDC_REDIRECT_URI_POSTLOGOUT = http://localhost:8080
# Dashboard UI defaults
# =====================
# How many timeslots should be shown by default? (has to be a string)
VUE_APP_TIMESLOT_FILTER_DEFAULT_NUMSLOTS = 10
# For how many days from now should timeslots be fetched by default? (has to be an int)
VUE_APP_TIMESLOT_FILTER_DEFAULT_DAYS = 60
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