Skip to content

SciPhi-AI/r2r-webdev-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Docs Discord Github Stars Commits-per-week License: MIT npm version

R2R

R2R Web Dev Template: A Next.js Starter for Building RAG-powered Web Apps

About

A simple web app template for starting applications with R2R. This template demonstrates how to integrate R2R's powerful RAG capabilities into a Next.js web interface, providing a foundation for more complex applications.

For a complete view of how to use R2R for web development, check out the web dev cookbook.

R2R Web Dev Template

Key Features

  • 📁 Multimodal Support: Ingest files ranging from .txt, .pdf, .json to .png, .mp3, and more.
  • 🔍 Hybrid Search: Combine semantic and keyword search with reciprocal rank fusion for enhanced relevancy.
  • 🔗 Graph RAG: Automatically extract relationships and build knowledge graphs.
  • 🗂️ App Management: Efficiently manage documents and users with rich observability and analytics.
  • 🌐 Client-Server: RESTful API support out of the box.
  • 🧩 Configurable: Provision your application using intuitive configuration files.
  • 🔌 Extensible: Develop your application further with easy builder + factory pattern.
  • 🖥️ Dashboard: Use the R2R Dashboard, an open-source React+Next.js app for a user-friendly interaction with R2R.

Getting Started

  1. Clone the repository:

    git clone https://github.com/SciPhi-AI/r2r-webdev-template.git
    cd r2r-webdev-template/r2r-webdev-template
  2. Install dependencies:

    pnpm install
  3. Make sure your R2R server is running.

  4. Start the development server:

    pnpm dev
  5. Open http://localhost:3000 in your browser to see the app.

Customization

  • Update the R2R server URL in pages/api/r2r-query.ts if needed.
  • Modify the UI in pages/index.tsx to fit your needs.
  • Add additional pages or components as your application grows.

Community and Support

  • Discord: Chat live with maintainers and community members
  • Github Issues: Report bugs and request features

Explore our R2R Docs for tutorials and cookbooks on various R2R features and integrations.

Contributing

We welcome contributions of all sizes! Here's how you can help:

Our Contributors