https://github.com/murabcd/openchat
Open-source AI Chatbot Built with Next.js, Convex and AI SDK
https://github.com/murabcd/openchat
ai chatgpt convex nextjs openai react shadcn-ui
Last synced: about 2 months ago
JSON representation
Open-source AI Chatbot Built with Next.js, Convex and AI SDK
- Host: GitHub
- URL: https://github.com/murabcd/openchat
- Owner: murabcd
- Created: 2025-02-10T14:32:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-14T07:23:35.000Z (6 months ago)
- Last Synced: 2025-12-16T10:42:41.624Z (6 months ago)
- Topics: ai, chatgpt, convex, nextjs, openai, react, shadcn-ui
- Language: TypeScript
- Homepage: https://openchat-beta.vercel.app
- Size: 2.76 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
An Open-source AI Chatbot Built With Next.js, Convex, and AI SDK.
Features ·
Model Providers ·
Deploy Your Own ·
Running locally
## Features
- [Next.js](https://nextjs.org) App Router
- Advanced routing for seamless navigation and performance
- React Server Components (RSCs) for server-side rendering and performance improvements
- [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
- Assisting with code generation, images, text editing, handling data, and searching the web
- [Redis](https://vercel.com/marketplace/redis)
- Persistent message streaming for real-time updates
- [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
- [Convex](https://www.convex.dev/) for saving chat history and user data
- [Convex file storage](https://docs.convex.dev/file-storage) for efficient file storage
- [Convex Vector Search](https://docs.convex.dev/search/vector-search) for long-term memory storage and retrieval
- [Convex Auth](https://labs.convex.dev/auth)
- Simple and secure authentication
## Model Providers
This app ships with [Openai](https://openai.com/) provider as the default. However, with the [AI SDK](https://sdk.vercel.ai/docs), you can switch LLM providers to [Ollama](https://ollama.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.
- Mini model (`gpt-4o-mini`): A fast and efficient model suitable for simple tasks
- Large model (`gpt-4o`): A powerful model designed for complex tasks
- Reasoning model (`o4-mini`): An advanced model configured for multi-step reasoning tasks
## Deploy Your Own
You can deploy your own version of the OpenChat to Vercel with one click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmurabcd%2Fopenchat&env=CONVEX_DEPLOY_KEY,OPENAI_API_KEY&envDescription=Learn%20more%20about%20how%20to%20get%20the%20API%20Keys%20for%20the%20application&envLink=https%3A%2F%2Fgithub.com%2Fmurabcd%2Fopenchat%2Fblob%2Fmain%2F.env.example&demo-title=OpenChat&demo-description=An%20open-source%20AI%20chatbot%20built%20with%20Next.js%2015%2C%20Convex%2C%20and%20AI%20SDK.&demo-url=https%3A%2F%2Fopenchat-beta.vercel.app)
## Running locally
You will need to use the environment variables [defined in `.env.example`](.env.example) to run OpenChat. 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
bun install
bun dev
```
Your app should now be running on [localhost:3000](http://localhost:3000/).
