diff --git a/README.md b/README.md index d8cac79..f66e515 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,29 @@ -# 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. +# julius_baer_onboarding -## ๐Ÿ” Features +# Project Setup Guide (Ubuntu Linux) -- Interactive client scenario simulations -- AI-powered decision recommendations -- Real-time scoring and feedback -- Progress tracking -- Document processing capabilities -- Comprehensive validation system +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. -## ๐ŸŽฏ Project Overview +--- -The Julius Baer Onboarding Simulation is a full-stack application that: -- Simulates real-world client interaction scenarios -- Provides AI-powered decision recommendations -- Tracks user performance and learning progress -- Offers an intuitive and engaging user interface +## ๐Ÿ”ง Installing prerequisites -## ๐Ÿ—๏ธ Architecture - -### 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 +### 1. Install Python 3.12 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 -curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - -sudo apt install -y nodejs -``` +See https://nodejs.org/en/download : Install v20.19.0 or higher + +--- ## ๐Ÿš€ Project Setup @@ -96,35 +64,34 @@ npm install cd .. ``` -## ๐Ÿ“ Project Structure +4. **Setup environment variables** +```bash +cp .env.example .env ``` -julius_baer_onboarding/ -โ”œโ”€โ”€ 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 -``` +And fill in your values and API keys in the newly created `.env` file. + +--- ## ๐Ÿงช 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`) \ No newline at end of file