Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 3.49 KB

README.md

File metadata and controls

109 lines (68 loc) · 3.49 KB
Raw

RAGMind - RAG-Powered Conversational AI Assistant for Enterprise Data, Enforced by Generative AI

RAGMind-logo

RAGMind, is your second brain, uses the power of GenerativeAI to be your personal assistant ! Turbocharged with AI capabilities to make it even easier for entreprises to easily bring the power of AI to their Dormant Data.

Key Features 🎯

  • Fast and Efficient: Designed with speed and efficiency at its core. RAGMind ensures rapid access to your data.
  • Secure: Your data, your control. Always.
  • OS Compatible: Ubuntu 22 or newer.
  • File Compatibility: Text, Markdown, PDF, Powerpoint, Excel, CSV, Word, Audio, Video.
  • Public/Private: Share your brains with your employees via a public link, or keep them private.
  • Marketplace: Share your brains with your colleagues, or use other people's brains to boost your productivity.
  • Offline Mode: RAGMind works offline, so you can access your data anytime, anywhere.

Demo Highlights 🎥

Getting Started 🚀

If you would like to deploy locally, follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

You can find everything on the documentation.

Prerequisites 📋

Ensure you have the following installed:

  • Docker
  • Docker Compose

60 seconds Installation 💽

You can find the installation video here.

  • Step 0: Supabase CLI

    Follow the instructions here to install the Supabase CLI that is required.

    supabase -v # Check that the installation worked

  • Step 1: Clone the repository:

    git clone https://github.com/yyassif/ragmind.git && cd ragmind

  • Step 2: Copy the .env.example files

    cp .env.example .env

  • Step 3: Update the .env files

    vim .env # or emacs or vscode or nano

    Update OPENAI_API_KEY in the .env file.

    You just need to update the OPENAI_API_KEY variable in the .env file. You can get your API key here. You need to create an account first. And put your credit card information. Don't worry, you won't be charged unless you use the API. You can find more information about the pricing here.

  • Step 4: Launch the project

    cd backend && supabase start

    and then

    cd ../
docker compose pull
docker compose up

    If you have a Mac, go to Docker Desktop > Settings > General and check that the "file sharing implementation" is set to VirtioFS.

    If you are a developer, you can run the project in development mode with the following command: docker compose -f docker-compose.dev.yml up --build

  • Step 5: Login to the app

    You can now sign in to the app with admin@yyassif.dev & admin. You can access the app at http://localhost:3000/login.

    You can access RAGMind backend API at http://localhost:5050/docs

    You can access supabase at http://localhost:54323

Updating RAGMind 🚀

  • Step 1: Pull the latest changes

    git pull

  • Step 2: Update the migration

    supabase migration up