From 734a3e51c98d55ea4d24eedee544832b6c85745c Mon Sep 17 00:00:00 2001
From: groegert <groegert@noreply.localhost>
Date: Thu, 20 May 2021 16:27:40 +0000
Subject: [PATCH] [core] added some hints to ease the initial development setup

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index 3fc156b..9aeb055 100644
--- a/README.md
+++ b/README.md
@@ -4,17 +4,45 @@ Modular student club administration system, licensed under the MIT license.
 
 ## Installation
 
+### Requirements
+```
+ "engines": {
+    "node": ">= 12.22.1",
+    "npm": ">= 6.14.12",
+    "yarn": ">= 1.21.1"
+ }
+```
+So on debian (buster and bullseye) you will need to install node.js and yarn beside the debian packages to meet the needed versions.
+
+```bash
+pushd ~/opt
+wget https://nodejs.org/dist/v16.2.0/node-v16.2.0-linux-x64.tar.xz
+tar -xJf node-v16.2.0-linux-x64.tar.xz
+export PATH="$(pwd)/node-v16.2.0-linux-x64/bin":"$PATH"
+npm i -g yarn
+npm i -g @quasar/cli
+popd
+```
 ### Install the dependencies
 
 ```bash
 yarn install
 ```
+Be aware npm might not work.
 
 ### Configure Plugins
 
 You can activate and deactive Plugins in `src/boot/plugins.ts`.
 You have to set the name of the Plugin into `config.loadModules`.
 
+### Configure Backend
+
+The application is using the API of [the backend](https://flaschengeist.dev/Flaschengeist/flaschengeist)
+This access needs to be configured in `src/config.ts'->config.baseURL
+
+- either you do have a proxy webserver that maps the '/api' to the backend (http://localhost:5000) or
+- you do directly configure the backend there:```baseURL: 'http://localhost:5000'```. Be aware not committing this configuration.
+
 ### Build the application
 
 ```bash