.. _quickstart:

==================
Quickstart Guide
==================

If you haven't yet, install RECAP repository following :ref:`installation`

Once installed, RECAP can be run either locally using the Python and Node.js applications or through Docker. The application consists of a backend API that runs the agent workflows and a React frontend that provides the chat interface.

Running API
-----------

With your Python virtual environment activated, start the backend api:

.. code-block:: bash

    python main.py --mode api

On the first startup, RECAP may take a few minutes to start up as it download necessary ollama models and ingests the review dataset.

Once start up is complete you can verify application is running by navigating to swagger docs: http://localhost:8000/docs

Running Frontend
----------------

With the API running, open a new terminal to start the frontend application. Run the following commands

.. code-block:: bash

    cd ui/
    npm run dev


The frontend can then be accessed at http://localhost:5173

Running Docker (Optional)
-------------------------

Optionally if you have built the docker images you can run the application
using docker instead of locally

.. code-block:: bash

    docker compose up

Next Steps
-------------------------

Now that application is up and running you can interact with the agents via the UI. To learn more about agents check out 
:doc:`agent_architecture`