66 lines
No EOL
3.8 KiB
Markdown
66 lines
No EOL
3.8 KiB
Markdown
<a href="https://chat.vercel.ai/">
|
|
<img alt="Next.js 13 and App Router-ready AI chatbot." src="https://chat.vercel.ai/opengraph-image">
|
|
<h1 align="center">Next.js AI Chatbot</h1>
|
|
</a>
|
|
|
|
<p align="center">
|
|
An open-source AI chatbot app built with [Next.js](https://nextjs.org), the [Vercel AI SDK](https://sdk.vercel.ai/docs), OpenAI, and [Vercel KV](https://vercel.com/storage/kv).
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#introduction"><strong>Introduction</strong></a> ·
|
|
<a href="#model-providers"><strong>Model Providers</strong></a> ·
|
|
<a href="#deploy-your-own"><strong>Deploy Your Own</strong></a> ·
|
|
<a href="#running-locally"><strong>Running locally</strong></a> ·
|
|
<a href="#authors"><strong>Authors</strong></a>
|
|
</p>
|
|
<br/>
|
|
|
|
# Introduction
|
|
|
|
- [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, HuggingFace, 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)
|
|
- [Next Auth](https://github.com/next-auth) for authentication
|
|
|
|
## Model Providers
|
|
|
|
This template ships with OpenAI `gpt-3.5-turbo` as the default. However, thanks to the [Vercel AI SDK](https://sdk.vercel.ai/docs), switching LLM providers to [Anthropic](https://anthropic.com), [HuggingFace](https://huggingface.co), or using [LangChain](https://js.langchain.com) 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?demo-title=Next.js+Chat&demo-description=A+full-featured%2C+hackable+Next.js+AI+chatbot+built+by+Vercel+Labs&demo-url=https%3A%2F%2Fchat.vercel.ai%2F&demo-image=%2F%2Fimages.ctfassets.net%2Fe5382hct74si%2F4aVPvWuTmBvzM5cEdRdqeW%2F4234f9baf160f68ffb385a43c3527645%2FCleanShot_2023-06-16_at_17.09.21.png&project-name=Next.js+Chat&repository-name=nextjs-chat&repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-chatbot&from=templates&skippable-integrations=1&env=OPENAI_API_KEY%2CAUTH_GITHUB_ID%2CAUTH_GITHUB_SECRET&envDescription=How+to+get+these+env+vars&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-chatbot%2Fblob%2Fmain%2F.env.example&teamCreateStatus=hidden&stores=[{"type":"kv"}])
|
|
|
|
## 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 should now be running on [localhost:3000](http://localhost:3000/).
|
|
|
|
## Authors
|
|
|
|
This library is created by [Vercel](https://vercel.com) and [Next.js](https://nextjs.org) team members, with contributions from:
|
|
|
|
- Jared Palmer ([@jaredpalmer](https://twitter.com/jaredpalmer)) - [Vercel](https://vercel.com)
|
|
- Shu Ding ([@shuding\_](https://twitter.com/shuding_)) - [Vercel](https://vercel.com)
|
|
- shadcn ([@shadcn](https://twitter.com/shadcn)) - [Contractor](https://shadcn.com) |