https://github.com/antoinewg/3x2y1z.com
your personal digital assistant, with publicly shareable conversations
https://github.com/antoinewg/3x2y1z.com
ai chatbot chatgpt convex google-search gpt-4 openai streaming
Last synced: 6 months ago
JSON representation
your personal digital assistant, with publicly shareable conversations
- Host: GitHub
- URL: https://github.com/antoinewg/3x2y1z.com
- Owner: antoinewg
- License: other
- Created: 2023-09-30T15:22:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T11:28:55.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T23:49:19.484Z (8 months ago)
- Topics: ai, chatbot, chatgpt, convex, google-search, gpt-4, openai, streaming
- Language: TypeScript
- Homepage: https://3x2y1z.com
- Size: 649 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An open-source AI chatbot app template built with Next.js, the Vercel AI SDK, OpenAI, and Vercel KV.
What's added in this repo, more than in the template:
- authentication with Clerk
- database with convex.dev
- use gpt-4 instead of gpt-3.5
## Features
- [Next.js](https://nextjs.org) App Router
- React Server Components (RSCs), Suspense, and Server Actions
- [Vercel AI SDK](https://sdk.vercel.ai/docs) for streaming chat UI
- Support for OpenAI (default), Anthropic, Hugging Face, or custom AI chat models and/or LangChain
- Edge runtime-ready
- [shadcn/ui](https://ui.shadcn.com)
- Styling with [Tailwind CSS](https://tailwindcss.com)
- [Radix UI](https://radix-ui.com) for headless component primitives
- Icons from [Phosphor Icons](https://phosphoricons.com)
- Chat History, rate limiting, and session storage with [Vercel KV](https://vercel.com/storage/kv)
- [Clerk](https://clerk.com/docs) for authentication and user management
## Model Providers
This template ships with OpenAI `gpt-4` as the default.
## Creating a KV Database Instance
Follow the steps outlined in the [quick start guide](https://vercel.com/docs/storage/vercel-kv/quickstart#create-a-kv-database) provided by Vercel. This guide will assist you in creating and configuring your KV database instance on Vercel, enabling your application to interact with it.
Remember to update your environment variables (`KV_URL`, `KV_REST_API_URL`, `KV_REST_API_TOKEN`, `KV_REST_API_READ_ONLY_TOKEN`) in the `.env` file with the appropriate credentials provided during the KV database setup.
Checkout to the branch `convex` to see convex as a primary database instead.
## 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/concepts/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/).