Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dphenomenal101/rag-chatbot
An open-source template for building a RAG chatbot for your company 🤖
https://github.com/dphenomenal101/rag-chatbot
ai chatbot chatgpt claude-3-5-sonnet gpt-4 groq llama nextjs rag rag-chatbot shadcn-ui template vercel
Last synced: 3 days ago
JSON representation
An open-source template for building a RAG chatbot for your company 🤖
- Host: GitHub
- URL: https://github.com/dphenomenal101/rag-chatbot
- Owner: Dphenomenal101
- License: other
- Created: 2024-10-24T09:33:30.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T20:14:13.000Z (about 1 month ago)
- Last Synced: 2024-12-21T01:41:33.543Z (4 days ago)
- Topics: ai, chatbot, chatgpt, claude-3-5-sonnet, gpt-4, groq, llama, nextjs, rag, rag-chatbot, shadcn-ui, template, vercel
- Language: TypeScript
- Homepage: https://ragie.vercel.app
- Size: 1.72 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An Open-Source RAG Chatbot Template Built With Ragie, Next.js, and the AI SDK by Vercel.
Features ·
Model Providers ·
Deploy Your Own ·
Running locally
## Features
- [Ragie.ai](https://ragie.ai/?utm_source=rag-chatbot)
- Fully Managed RAG-as-a-service Platform for Developers
- [Next.js](https://nextjs.org) App Router
- Advanced routing for seamless navigation and performance
- React Server Components (RSCs) and Server Actions for server-side rendering and increased performance
- [AI SDK](https://sdk.vercel.ai/docs)
- Unified API for generating text, structured objects, and tool calls with LLMs
- Hooks for building dynamic chat and generative user interfaces
- Supports OpenAI (default), Anthropic, Cohere, and other model providers
- [shadcn/ui](https://ui.shadcn.com)
- Styling with [Tailwind CSS](https://tailwindcss.com)
- Component primitives from [Radix UI](https://radix-ui.com) for accessibility and flexibility
- Data Persistence
- [Vercel Postgres powered by Neon](https://vercel.com/storage/postgres) for saving chat history and user data
- [Vercel Blob](https://vercel.com/storage/blob) for efficient file storage
- [NextAuth.js](https://github.com/nextauthjs/next-auth)
- Simple and secure authentication
## Model Providers
This template ships with OpenAI `GPT4-o` as the default. However, with the [AI SDK](https://sdk.vercel.ai/docs), you can switch LLM providers to [OpenAI](https://openai.com), [Anthropic](https://anthropic.com), [Cohere](https://cohere.com/), and [many more](https://sdk.vercel.ai/providers/ai-sdk-providers) with just a few lines of code.
## Deploy Your Own
You can deploy your own version of the Next.js AI Chatbot to Vercel with one click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDphenomenal101%2Frag-chatbot&env=RAGIE_API_KEY,OPENAI_API_KEY,POSTGRES_URL,AUTH_SECRET&project-name=ragie-chatbot&repository-name=ragie-chatbot)
## Running locally
You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js AI Chatbot. It's recommended you use [Vercel Environment Variables](https://vercel.com/docs/projects/environment-variables) for this, but a `.env` file is all that is necessary.
> Note: You should not commit your `.env` file or it will expose secrets that will allow others to control access to your various OpenAI and authentication provider accounts.
1. Install Vercel CLI: `npm i -g vercel`
2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link`
3. Download your environment variables: `vercel env pull`
```bash
pnpm install
pnpm dev
```
Your app template should now be running on [localhost:3000](http://localhost:3000/).
By default, the Chatbot acts as an HR/People Ops assistant designed to help onboard new employees at PostHog. It was trained using their open-source [Handbook](https://posthog.com/handbook), you can adjust the system prompt and customize the RAG Chatbot for any use-case.