https://github.com/shub4am/rag-app
A Next.js-based Retrieval-Augmented Generation (RAG) chat application
https://github.com/shub4am/rag-app
nextjs openaiapi qdrant rag rag-chatbot tailwindcss typescript
Last synced: 6 months ago
JSON representation
A Next.js-based Retrieval-Augmented Generation (RAG) chat application
- Host: GitHub
- URL: https://github.com/shub4am/rag-app
- Owner: Shub4am
- Created: 2025-08-20T09:12:58.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-08-20T10:47:11.000Z (7 months ago)
- Last Synced: 2025-08-20T11:30:13.421Z (7 months ago)
- Topics: nextjs, openaiapi, qdrant, rag, rag-chatbot, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://codebook-rag.vercel.app/
- Size: 117 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RAG App
A Next.js-based Retrieval-Augmented Generation (RAG) application that allows users to upload, index, and chat with their documents (CSV, PDF, and URLs). The app provides a chat interface for querying indexed data and supports document management features.
## Features
- Upload and index documents (CSV, PDF, URLs)
- Chat interface for querying indexed data
- Document management panel
- Sidebar for navigation
- Modern UI built with Next.js and TypeScript
- API endpoints for chat and document operations
## Project Structure
```
├── app/
│ ├── api/ # API routes for chat, collections, and document ingestion
│ ├── components/ # React components (ChatInterface, DocumentPanel, etc.)
│ ├── globals.css # Global styles
│ ├── layout.tsx # App layout
│ └── page.tsx # Main page
├── lib/ # Utility functions
├── public/ # Static assets
├── types/ # TypeScript types
├── uploads/ # Uploaded files
├── package.json # Project dependencies and scripts
├── tsconfig.json # TypeScript configuration
├── next.config.ts # Next.js configuration
├── docker-compose.yml # Docker setup
└── README.md # Project documentation
```
## Project Screenshot
### Prerequisites
- Node.js (v18+ recommended)
- npm or yarn
### Installation
1. Clone the repository:
```sh
git clone https://github.com/Shub4am/rag-app.git
cd rag-app
```
2. Install dependencies:
```sh
npm install
# or
yarn install
```
3. Start the development server:
```sh
npm run dev
# or
yarn dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser.
## Usage
- Upload documents via the interface.
- Use the chat to ask questions about your documents.
- Manage your documents in the document panel.
## Scripts
- `npm run dev` — Start the development server
- `npm run build` — Build for production
- `npm run start` — Start the production server
- `npm run lint` — Lint the codebase
## Contributing
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](LICENSE)