installation.md

Docker Installation

More information will follow shortly

Local Installation

Run:

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn run dev

# build once and launch server
$ yarn run build
$ yarn run start

For detailed explanation on how things work, checkout the Nuxt.js docs.

Env Vars

More information on environment variables can be found in the documentation (WIP)

Test Logins

Role	E-Mail	Password
Admin	[email protected]	1234
Moderator	[email protected]	1234
User	[email protected]	1234

Access over WiFi

In order to make your web app accessible from your local WiFi you have to configure WEBAPP_HOST, WEBAPP_BASE_URL and API_HOST depending on your IP address within that network. E.g. on Linux you can check your IP address with ip addr. Here's an example .env file for an IP address 192.168.178.42:

# .env 
WEBAPP_HOST     = 192.168.178.42
WEBAPP_BASE_URL = http://192.168.178.42:3000
API_HOST        = 192.168.178.42

You can use this configuration e.g. to test the webapp from your mobile phone.

Styleguide

The Developer Style Guide provides important infos about components and styles. To start it simply type:

$ yarn run styleguide

When built you can open it at http://localhost:6060

Backpack

We use backpack to watch and build the application, so you can use the latest ES6 features (module syntax, async/await, etc.).