Overview

The R2R Dashboard is an open-source React+Next.js application aimed at R2R developers, providing them with an intuitive interface to interact with their pipelines efficiently. By reducing development and iteration time, this dashboard enhances the user experience for developers.

Features

• Document Management: Upload, update, and delete documents along with their metadata.
• Playground: Stream RAG responses with different models and customizable settings.
• Analytics: View aggregate statistics on latencies and metrics through detailed histograms.
• Logs: Track user queries, search results, and LLM responses.
• Development Tools: Easily initiate a development server, format code, and conduct lint checks.

Installation

Install PNPM

PNPM is used as the package manager for the R2R Dashboard. Follow these steps to install PNPM on Unix-based systems (Linux, macOS) and Windows. Ensure to add PNPM to your system’s PATH.

Clone and Setup the R2R Dashboard

1. Clone the project repository and navigate to the project directory.
2. Install project dependencies using PNPM.

   pnpm install
   

3. Build and start the application for production.

   pnpm start
   

   View the dashboard at http://localhost:3000.

Developing with R2R Dashboard

• To develop on the R2R Dashboard, start a development server and run pre-commit checks to ensure code quality.

Summary

The R2R Dashboard offers a user-friendly interface with core features tailored to manage and monitor Retrieval-Augmented Generation (RAG) pipelines in the R2R framework efficiently. By facilitating streamlined interactions with RAG systems, this tool enhances development and operational workflows for developers.