Improve readme + update .env.example

.env.example

@@ -1,6 +1,8 @@
-API_URI=
+API_URI=https://hackathon-api.mlo.sehlat.io
-API_KEY=
+API_KEY=your_julius_bar_api_key
-API_TEAM=
+API_TEAM=your_swisshacks_team_name
-GAME_FILES_DIR=/project_absolute_path/game_files
+GAME_FILES_DIR=/path/to/julius_baer_onboarding/game_files
-MISTRAL_API_KEY=
+GROQ_API_KEY=your_groq_api_key
-OPENAI_API_KEY=
+GOOGLE_API_KEY=your_google_api_key
+MISTRAL_API_KEY=your_mistral_api_key
+OPENAI_API_KEY=your_openai_api_key

README.md

@@ -7,20 +7,7 @@ This project consists of a Python backend and a JavaScript frontend. The followi
 
 ---
 
-## ✅ Prerequisites
+## 🔧 Installing prerequisites
-
-Install the following system dependencies:
-
-- Python 3.12
-- pip
-- virtualenv
-- Node.js (v16+)
-- npm
-- tesseract-ocr
-
----
-
-## 🔧 Installation Steps
 
 ### 1. Install Python 3.12 and Required Tools
 
@@ -47,10 +34,7 @@ sudo apt install tesseract-ocr
 
 ### 3. Install Node.js and npm
 
-```bash
+See https://nodejs.org/en/download : Install v20.19.0 or higher
-curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
-sudo apt install -y nodejs
-```
 
 ---
 
@@ -80,13 +64,12 @@ npm install
 cd ..
 ```
 
----
+4. **Setup environment variables**
 
-## 📁 Project Structure
+```bash
-
+cp .env.example .env
-- `requirements.txt` — Python dependencies
+```
-- `.venv/` — Python virtual environment
+And fill in your values and API keys in the newly created `.env` file.
-- `frontend/` — JavaScript frontend (managed with npm)
 
 ---
 
@@ -98,6 +81,12 @@ cd ..
 source .venv/bin/activate
 ```
 
+- To run the backend:
+
+```bash
+python app.py
+```
+
 - To run the frontend:
 
 ```bash
@@ -105,8 +94,4 @@ cd frontend
 npm run dev
 ```
 
-- To run the backend:
+Then open your browser to http://localhost:5174/ (or the address displayed after running `npm run dev`)
-
-```bash
-python app.py
-```