.. _installation:

==================
Installation Guide
==================

Below on the instructions for installing the code locally

Prerequisites
-------------

- `Python <https://www.python.org/downloads/>`_ 3.12 or newer
- `Node.js <https://nodejs.org/>`_ — **LTS version recommended**.
- `Ollama <https://ollama.com/download>`_

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:

.. code-block:: bash

    python --version

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

.. code-block:: bash

    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:

.. code-block:: bash

    deactivate

Frontend
--------

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

.. code-block:: bash

    cd ui/
    npm install


Docker Installation Guide
-------------------------

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

- `Docker <https://docs.docker.com/engine/install/>`_

.. code-block:: bash

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