README + mistral dep

This commit is contained in:
Nitwix
2025-04-13 10:20:16 +02:00
parent 38c2a1b767
commit 5edb950aab
2 changed files with 112 additions and 0 deletions

111
README.md
View File

@ -1 +1,112 @@
# julius_baer_onboarding
# Project Setup Guide (Ubuntu Linux)
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.
---
## ✅ 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
#### For Ubuntu 22.04+
```bash
sudo apt update
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
```bash
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
```
---
## 🚀 Project Setup
1. **Clone the repository**
```bash
git clone https://github.com/NoeBerdoz/julius_baer_onboarding
cd julius_baer_onboarding
```
2. **Set up the Python virtual environment**
```bash
python3.12 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
```
3. **Install frontend dependencies**
```bash
cd frontend
npm install
cd ..
```
---
## 📁 Project Structure
- `requirements.txt` — Python dependencies
- `.venv/` — Python virtual environment
- `frontend/` — JavaScript frontend (managed with npm)
---
## 🧪 Development Workflow
- Activate the Python virtual environment:
```bash
source .venv/bin/activate
```
- To run the frontend:
```bash
cd frontend
npm run dev
```
- To run the backend:
```bash
python app.py
```

View File

@ -44,3 +44,4 @@ langchain-openai
numpy==2.2.4
pymupdf == 1.25.5
flask-cors==5.0.1
mistralai==1.6.0