WS23/24

CONTRIBUTING.md

@@ -11,7 +11,7 @@ You should know how to program in object oriented languages. Prior experience wi
 You need to install the necessary tools.
 
 * [Git](https://git-scm.com/downloads)
-* [Node.js 14 LTS](https://nodejs.org/en/)
+* [Node.js 18 LTS](https://nodejs.org/en/)
 * [Visual Studio Code](https://code.visualstudio.com/)
 * [ESLint for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
@@ -20,30 +20,41 @@ You need to install the necessary tools.
 Make a personal copy of the source code using the *Fork* button on the top right of this page.
 
 Open a terminal (e.g. PowerShell if you're on Windows) and download the source code to your PC using Git:
+
 ```bash
 git clone https://github.com/your-github-username/THI-App.git
 cd THI-App/rogue-thi-app
 ```
 
 Download everything else that is required to run the app:
+
 ```bash
 npm install
+# or
+yarn
 ```
 
+> **Note**
+> For node.js versions 17 and above, you need to set the environment variable `NODE_OPTIONS=--openssl-legacy-provider` to avoid an error when installing the dependencies.
+
 Now open the `rogue-thi-app` folder in Visual Studio Code.
 
 ## Developing
 
 Start the application locally:
+
 ```bash
 npm run dev
+# or
+yarn dev
 ```
 
-Go to https://localhost:3000 in your browser and voilà, you're ready to go. You can change things in your code and your browser will automatically load the new version.
+Go to [https://localhost:3000](https://localhost:3000) in your browser and voilà, you're ready to go. You can change things in your code and your browser will automatically load the new version.
 
 ### Structure of the code
 
 A quick overview over the structure of the source code:
+
 * `/pages`  
 The pages of the application that you see in your browser. This is where to look if you want to change the structure of the UI.
 * `/components`  
@@ -55,4 +66,4 @@ Various reusable utilities such as a client for the THI API and a timestamp form
 
 ## Getting help
 
-If you need help with the code, don't hesitate to contact us at [email protected].
+If you need help with the code, don't hesitate to contact us at [[email protected]](mailto:[email protected]).

Dockerfile

@@ -42,19 +42,24 @@ RUN mkdir ./splash && npx pwa-asset-generator --no-sandbox=true --path-override
 
 
 
-FROM node:16
+FROM node:18
 
 WORKDIR /opt/next
 
 ARG NEXT_PUBLIC_HACKERMAN_FLAGS
 ARG NEXT_PUBLIC_ELECTION_URL
 ARG NEXT_PUBLIC_GUEST_ONLY
+ARG NEXT_PUBLIC_THI_API_MODE
+ARG NEXT_PUBLIC_THI_API_KEY
 ENV NEXT_PUBLIC_HACKERMAN_FLAGS $NEXT_PUBLIC_HACKERMAN_FLAGS
 ENV NEXT_PUBLIC_ELECTION_URL $NEXT_PUBLIC_ELECTION_URL
 ENV NEXT_PUBLIC_GUEST_ONLY $NEXT_PUBLIC_GUEST_ONLY
+ARG NEXT_PUBLIC_THI_API_MODE $NEXT_PUBLIC_THI_API_MODE
+ENV NEXT_PUBLIC_THI_API_KEY $NEXT_PUBLIC_THI_API_KEY
 
 COPY rogue-thi-app/package.json rogue-thi-app/package-lock.json ./
-RUN npm install
+# OpenSSL legacy provider needed to build node-forge
+RUN NODE_OPTIONS=--openssl-legacy-provider npm install
 COPY rogue-thi-app/ .
 COPY --from=spo /opt/spo-grade-weights.json data/
 COPY --from=distances /opt/room-distances.json data/

README.md

@@ -22,7 +22,7 @@ You can find more information on this in [this document](docs/data-security.md).
 Currently the documentation consists of a list of valid requests and examples
 of their responses.
 You can view [the full list here](docs/thi-rest-api.md). This documentation was
-created manually by using the official app and logging requests with mitmproxy.
+created manually by using the official app and logging requests with `mitmproxy`.
 The app also includes a [debugging tool](https://neuland.app/debug) which handles session generation
 and API communication.
 

docs/data-security-de.md

@@ -1,14 +1,18 @@
 # Neuland App Datensicherheit
+
 TL;DR: Nur du und die THI Haben Zugriff auf dein Passwort sowie deine
 persönlichen Daten.
 
-### Speichert ihr meine Daten?
+## Speichert ihr meine Daten?
+
 Nur lokal auf deinem Gerät.
 
-### Klaut ihr mein Passwort?
+## Klaut ihr mein Passwort?
+
 Wir haben keinen Zugriff auf dein Passwort.
 
-### Wie funktioniert das?
+## Wie funktioniert das?
+
 Normalerweise wenn man der Browser eine REST API benutzt wird `fetch` oder
 `XMLHttpRequests` in Javascript benutzt. Der Browser verhindert aber dass
 eine Seite A (z.B. neuland.app) auf eine Seite B (z.B. thi.de) zugreift.
@@ -21,6 +25,7 @@ Anfragen an thi.de werden also im Browser verschlüsselt und nur von unserem
 Proxy weitergegeben. So hat nur der THI Server und der Browser Zugriff auf
 Passwörter und Nutzerdaten.
 
-### Ich vertraue euch trotzdem nicht!
+## Ich vertraue euch trotzdem nicht
+
 Gerne kannst du hier auf Github den Source Code der Neuland App lesen und
 diese wenn du möchtest auch selbst auf deinem Server installieren.

docs/data-security.md

@@ -1,19 +1,24 @@
 # Neuland App Data Safety
+
 TL;DR: Only you and the THI will have access to your password and other
 sensitive information.
 
-### Will my data be stored?
+## Will my data be stored?
+
 Only on your own device.
 
-### Will you steal my password?
+## Will you steal my password?
+
 We can't.
 
-### Will my data be accesible to you?
+## Will my data be accesible to you?
+
 No. It is transmitted end to end encrypted between your browser and the THI
 Server. Even though our server is used as a proxy we can only see encrypted
 data.
 
-### How does this work?
+## How does this work?
+
 Normally when accessing a REST API your browser makes requests to it using
 `fetch` or `XMLHttpRequests`. Because of CORS policies the App is not able to
 directly contact the THI API. Instead it connects via a Proxy which is hosted
@@ -24,6 +29,7 @@ a full javascript implementation of TLS and HTTP. This way packets are
 encrypted in your browser and simply relayed by our server. Only the THI server
 and your browser have access to plain text packet contents.
 
-### What if i still do not trust you?
+## What if i still do not trust you?
+
 You can read the source code of the neuland app here on github.
 If you want, you can even install it on your own server.