readme

README.md

@@ -1,60 +1,29 @@
-# Julius Baer Onboarding
+# julius_baer_onboarding
-
-An interactive onboarding simulation system designed for Julius Baer, a decision-based game interface. This project helps users understand client interaction scenarios and decision-making processes in a private banking context.
 
 
-## 🔍 Features
+# Project Setup Guide (Ubuntu Linux)
 
-- Interactive client scenario simulations
+This project consists of a Python backend and a JavaScript frontend. The following instructions describe how to set up the development environment manually on Ubuntu.
-- AI-powered decision recommendations
-- Real-time scoring and feedback
-- Progress tracking
-- Document processing capabilities
-- Comprehensive validation system
 
-## 🎯 Project Overview
+---
 
-The Julius Baer Onboarding Simulation is a full-stack application that:
+## 🔧 Installing prerequisites
-- Simulates real-world client interaction scenarios
-- Provides AI-powered decision recommendations
-- Tracks user performance and learning progress
-- Offers an intuitive and engaging user interface
 
-## 🏗️ Architecture
+### 1. Install Python 3.12 and Required Tools
-
-### Backend (Python/Flask)
-- RESTful API endpoints for game management
-- Integration with Julius Baer's API
-- AI advisor for decision recommendations
-- Game state management and scoring system
-- OCR capabilities for document processing
-
-### Frontend (Alpine.js & Bootsrap)
-- Modern, responsive user interface
-- Interactive game flow
-- Real-time decision feedback
-- Score tracking and progress visualization
-
-## ✅ Prerequisites
-
-Install the following system dependencies:
-
-- Python 3.12
-- pip
-- virtualenv
-- Node.js (v16+)
-- npm
-- tesseract-ocr
-
-## 🔧 Installation Steps
-
-### 1. Install Python 3.11+ and Required Tools
 
 #### For Ubuntu 22.04+
 
 ```bash
 sudo apt update
-sudo apt install python3.11 python3.11-venv python3.11-dev
+sudo apt install python3.12 python3.12-venv python3.12-dev
+```
+
+#### For Ubuntu 20.04
+
+```bash
+sudo add-apt-repository ppa:deadsnakes/ppa
+sudo apt update
+sudo apt install python3.12 python3.12-venv python3.12-dev
 ```
 
 ### 2. Install Tesseract OCR
@@ -65,10 +34,9 @@ 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
+---
-```
 
 ## 🚀 Project Setup
 
@@ -96,35 +64,34 @@ npm install
 cd ..
 ```
 
-## 📁 Project Structure
+4. **Setup environment variables**
 
+```bash
+cp .env.example .env
 ```
-julius_baer_onboarding/
+And fill in your values and API keys in the newly created `.env` file.
-├── app.py                 # Main Flask application
+
-├── config.py             # Configuration settings
+---
-├── requirements.txt      # Python dependencies
-├── frontend/            # Frontend application
-├── services/            # Backend services
-├── dto/                 # Data Transfer Objects
-├── validation/          # Validation logic
-├── utils/              # Utility functions
-├── game_files/         # Game-related files
-└── tests/              # Test suite
-```
 
 ## 🧪 Development Workflow
 
-1. **Start the backend server**
+- Activate the Python virtual environment:
 
 ```bash
 source .venv/bin/activate
+```
+
+- To run the backend:
+
+```bash
 python app.py
 ```
 
-2. **Start the frontend development server**
+- To run the frontend:
 
 ```bash
 cd frontend
 npm run dev
 ```
 
+Then open your browser to http://localhost:5174/ (or the address displayed after running `npm run dev`)