Installation

Installation Guide

This guide will help you set up the RAG Process Visualizer on your local machine.

Prerequisites

Before installing, ensure you have the following installed:

• Node.js (version 18.0 or higher)
• npm (version 9.0 or higher) or yarn
• Git (for cloning the repository)

Checking Your Versions

node --version  # Should be v18.0.0 or higher
npm --version   # Should be 9.0.0 or higher
git --version

Installation Steps

1. Clone the Repository

git clone https://github.com/KHemanthRaju/RAG_Visualizer.git
cd RAG_Visualizer

2. Install Dependencies

Using npm:

npm install

Or using yarn:

yarn install

This will install all required dependencies including:

• Next.js 14
• React 18
• TypeScript
• Tailwind CSS
• Framer Motion
• Lucide React

3. Run the Development Server

npm run dev

Or with yarn:

yarn dev

4. Open in Browser

Navigate to http://localhost:3000 in your web browser.

Building for Production

To create an optimized production build:

npm run build

To start the production server:

npm start

Environment Variables

Currently, no environment variables are required. The application uses simulated embeddings and generation for demonstration purposes.

For production use with real APIs, you would need to set:

OPENAI_API_KEY=your_key_here
VECTOR_DB_API_KEY=your_key_here

Troubleshooting

Port Already in Use

If port 3000 is already in use, Next.js will automatically try the next available port (3001, 3002, etc.).

Module Not Found Errors

If you encounter module not found errors:

rm -rf node_modules package-lock.json
npm install

TypeScript Errors

Ensure you have the latest TypeScript version:

npm install -D typescript@latest

Next Steps

Once installed, check out the User Guide to learn how to use the application.