Skip to main content

Prerequisites

Before you begin, ensure you have the following installed:
  • Python 3.8+ - Required for the backend server
  • Node.js & npm - Required for the frontend application
  • Mistral API Key - Required for AI-powered features. Get your API key here

Backend Setup

1

Navigate to the backend directory

Open your terminal and navigate to the root directory:
cd be
2

Create a virtual environment

Create and activate a Python virtual environment:
python -m venv myenv
myenv\Scripts\activate
3

Install Python dependencies

Install all required packages from requirements.txt:
pip install -r requirements.txt

Key Dependencies

The platform uses the following major packages:Web Framework
  • flask==3.1.3 - Main web framework
  • flask-cors==6.0.2 - Cross-origin resource sharing
  • flask-sqlalchemy==3.1.1 - Database ORM
  • flask-login==0.6.3 - User authentication
  • flask-socketio==5.6.1 - Real-time communication
AI & Machine Learning
  • mistralai==1.12.4 - Mistral AI API client
  • openai==1.65.0 - OpenAI integration
  • faiss-cpu==1.13.2 - Vector similarity search
  • sentence-transformers==5.2.3 - Text embeddings
  • torch==2.10.0 - Deep learning framework
  • spacy==3.8.11 - Natural language processing
Audio Processing
  • librosa==0.11.0 - Audio analysis
  • faster-whisper==1.2.1 - Speech-to-text
  • pydub==0.25.1 - Audio manipulation
Security & Authentication
  • PyJWT==2.11.0 - JSON Web Tokens
  • cryptography==46.0.5 - Cryptographic functions

Frontend Setup

1

Navigate to the frontend directory

From the be directory, navigate to the frontend folder:
cd frontend
2

Install Node.js dependencies

Install all required npm packages:
npm install
This step is only required on the first run or when dependencies change.

Verification

After completing the installation, verify that:
  • Your virtual environment is activated (you should see (myenv) in your terminal)
  • All Python packages installed successfully without errors
  • Node modules are present in the frontend/node_modules directory
Installation complete! Next, proceed to Configuration to set up your environment variables and database.

Build docs developers (and LLMs) love