Documentation

README.md

@@ -1,17 +1,31 @@
 # P3-BM-dashboard
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ligula sem, consectetur a risus euismod, finibus eleifend augue. Suspendisse mauris arcu, vestibulum sit amet libero pellentesque, commodo commodo tellus. Donec sit amet ex odio. In dictum egestas metus, non pellentesque arcu. Mauris eros velit, euismod pulvinar vehicula et, faucibus eget velit. Maecenas accumsan mattis vestibulum. Curabitur vitae nibh eros. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. 
 
 # Getting started
-## Pre-requisites for running
-- **Java 21 installed**
-  - Confirm with `java -version`
+## Installing dependencies and tooling
+
+### 1. Install Java 21
+- Confirm your current version with `java -version`
+
+It should be version 21.x.x
 ```
 PS C:\Users\olive\Documents\Programming\P3-BM-dashboard\backend> java -version
 openjdk version "21.0.1" 2023-10-17 LTS
 OpenJDK Runtime Environment Temurin-21.0.1+12 (build 21.0.1+12-LTS)
 OpenJDK 64-Bit Server VM Temurin-21.0.1+12 (build 21.0.1+12-LTS, mixed mode, sharing)
 ```
-- **Maven installed**
-  - Confirm with `mvn -version`
+
+Otherwise download and install [here](https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.1+12/OpenJDK21U-jdk_x64_windows_hotspot_21.0.1_12.msi)
+
+1. Use the wizard
+   - **important!** choose "Set JAVA_HOME variable
+
+### 2. Install Maven
+1. Download, unpack and add to "PATH"
+   - [Installing Apache Maven](https://maven.apache.org/install.html)
+2. Confirm correct version is installed
+   - `mvn -version`
+
 ```
 PS C:\Users\olive\Documents\Programming\P3-BM-dashboard\backend> mvn -version
 Apache Maven 3.9.4 (dfbb324ad4a7c8fb0bf182e6d91b0ae20e3d2dd9)
@@ -21,14 +35,39 @@ Default locale: en_US, platform encoding: UTF-8
 OS name: "windows 11", version: "10.0", arch: "amd64", family: "windows"
 ```
 
+### 3. Install Docker Desktop
+
+> [!WARNING]
+> Spring is broken with the *latest* docker compose version 2.23.0, and **will not run**.
+> 
+> Instead of downloading latest, use version `4.23.0` of Docker Desktop [here](https://docs.docker.com/desktop/release-notes/#4230)
+> Confirm with `docker-compose --version`
+
+### 4. Install MongoDB Compass
+MongoDB Compass allows you to browse the database.
+
+1. Download and install [here](https://www.mongodb.com/products/tools/compass)
+2. Check the `docker-compose` for database password and user (Authorization)
+```
+- 'MONGO_INITDB_DATABASE=dashboard-db'
+- 'MONGO_INITDB_ROOT_PASSWORD=secret'
+- 'MONGO_INITDB_ROOT_USERNAME=root'
+```
+3. Connect via `mongodb://root:secret@localhost:27017/?authMechanism=DEFAULT`
+
+# Running and building
 ## Running the backend (developing)
+To start Spring for backend developing
+
 1. Enter the backend directory with `cd /backend`
 2. Run the application with `mvn spring-boot:run`
-  - Spring boot will run ``docker compose up`` with the "frontend" profile.
+  - Spring boot will run ``docker compose up``
   - This will launch a `mongodb` database container **only** (Don't build the Java backend docker container, since it will launch locally)
 3. Stop the application by exiting the terminal, or issuing `mvn spring-boot:stop`
 
-## Building and running with Docker Compose
+## Building and running the whole stack with Docker Compose
+To build frontend, and backend and start the whole stack. Mostly for deployment.
+
 1. Enter the projects root directory
 2. Use `docker compose up --build`
    - This will force a `--build` instead of pulling.