From 9d1cc72f079c05f696d99162fa610eb86bddded0 Mon Sep 17 00:00:00 2001
From: Martin Klampfer <martin.klampfer@fairkom.eu>
Date: Wed, 16 Jun 2021 15:09:57 +0200
Subject: [PATCH] added section on how to set up a development environment for
 the html5 client to README.md

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

diff --git a/README.md b/README.md
index 58c1f11302..8aff5f0378 100644
--- a/README.md
+++ b/README.md
@@ -17,4 +17,31 @@ You can install on a Ubuntu 18.04 64-bit server.  We provide [bbb-install.sh](ht
 
 For full technical documentation BigBlueButton -- including architecture, features, API, and GreenLight (the default front-end) -- see [https://docs.bigbluebutton.org/](https://docs.bigbluebutton.org/).
 
-BigBlueButton and the BigBlueButton Logo are trademarks of [BigBlueButton Inc](https://bigbluebutton.org) .
+Setting up a development environment for the HTML 5 client
+==========================================================
+
+After installing BBB 2.3 using [this tutorial](https://docs.bigbluebutton.org/2.3/install.html),
+follow these steps to set a development environment:
+
+* Install meteor.js: ```curl https://install.meteor.com/ | sh```
+* Clone the [fairblue repository](https://git.fairkom.net/chat/fairblue.git):
+    ```git clone https://git.fairkom.net/chat/fairblue.git```  
+
+* Navigate to the fairblue directory that was created
+* Checkout the desired branch (e.g. feature/translation-2.3.x when working on the translation feature):
+  
+    ```git checkout feature/translation-2.3.x```
+* navigate to ```<fairblue>/bigbluebutton-html5```
+* set meteor version to 1.10.2
+
+    ```meteor update --allow-superuser --release 1.10.2```
+
+* get the web socket url from the BBB installation and insert it into the config
+
+    * ```grep "wsUrl" /usr/share/meteor/bundle/programs/server/assets/app/config/settings.yml```
+    * open ```<fairblue>/bigbluebutton-html5/private/config/settings.yml```
+    * set the "wsUrl" value to the url that was retrieved before
+
+* ```meteor npm install```
+* run the html5 client using ```npm start```. [Screen](https://www.gnu.org/software/screen/) can be used to keep the session open when the shell is closed.
+
-- 
GitLab