Installation Guide

Below on the instructions for installing the code locally

Prerequisites

Python 3.12 or newer
Node.js — LTS version recommended.
Ollama

We use the venv package from the Python standard library to install RECAP’s dependencies without conflicting with existing libraries in your system.

Backend API

To check that a compatible version of Python is installed, run:

python --version

Run the following commands to clone the RECAP repository and create and activate a Python virtual environment.

git clone git@github.com:vtnsi/recap.git
cd recap/
python -m venv .venv
source .venv/bin/activate # Linux/macOS
source .venv/Scripts/activate # Windows

To exit the Python virtual environment, run:

deactivate

Frontend

Next install the necessary dependencies to run the frontend react application:

cd ui/
npm install

Docker Installation Guide

Optionally you can also install and run the applications via docker:

Docker

git clone git@github.com:vtnsi/recap.git
cd recap/
docker compose build