R2R Application
react + next.js dashboard for R2R: The most advanced AI retrieval system. Containerized, Retrieval-Augmented Generation (RAG) with a RESTful API.
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.
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
- Clone the project repository and navigate to the project directory.
- Install project dependencies using PNPM.
pnpm install
- Next.js
Next.js is a React-based web framework that enables server-side rendering, static site generation, and other powerful features for building modern web applications.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Framer Motion
Alpine.js is a lightweight JavaScript framework that simplifies the process of creating dynamic, reactive user interfaces on the web. It uses a declarative syntax that offers a higher level of abstraction compared to vanilla JavaScript, while being more performant and easier to use than jQuery.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
