chatbot README

The project's README from github.com/vercel/chatbot. As one markdown file: README.md.

Chatbot

Chatbot

Chatbot (formerly AI Chatbot) is a free, open-source template built with Next.js and the AI SDK that helps you quickly build powerful chatbot applications.

Read Docs · Features · Model Providers · Deploy Your Own · Running locally


Features

Model Providers

This template uses the Vercel AI Gateway to access multiple AI models through a unified interface. Models are configured in lib/ai/models.ts with per-model provider routing. Included models: Mistral, Moonshot, DeepSeek, OpenAI, and xAI.

AI Gateway Authentication

For Vercel deployments: Authentication is handled automatically via OIDC tokens.

For non-Vercel deployments: You need to provide an AI Gateway API key by setting the AI_GATEWAY_API_KEY environment variable in your .env.local file.

With the AI SDK, you can also switch to direct LLM providers like OpenAI, Anthropic, Cohere, and many more with just a few lines of code.

Deploy Your Own

You can deploy your own version of Chatbot to Vercel with one click:

Deploy with Vercel

Running locally

You will need to use the environment variables defined in .env.example to run Chatbot. It's recommended you use Vercel 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 AI 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
pnpm install
pnpm db:migrate # Setup database or apply latest database changes
pnpm dev

Your app template should now be running on localhost:3000.

chatbot (vercel/chatbot)

Searching Database…

21K ·GitHub
Chatbot
Что это такое?Шаблон open-source чат-бота с ИИ, созданный Vercel на Next.js и AI SDK. Он задуман как отправная точка для создания собственных чат-ботов.
Так это готовое работающее приложение с чат-ботом или скорее заготовка кода?Это шаблон, который можно дорабатывать: полноценное запускаемое приложение-чатбот (интерфейс чата, авторизация, история переписки, хранение файлов), которое вы разворачиваете и настраиваете под себя, а не готовый продукт в облаке.
Как запустить его у себя локально?Установите Vercel CLI (npm i -g vercel), выполните vercel link, затем vercel env pull, чтобы скачать свои переменные окружения, — после этого приложение запустится на localhost:3000.
Мне нужен свой API-ключ для моделей ИИ?Если развернуть проект на Vercel, авторизация в AI Gateway происходит автоматически через OIDC-токены. При запуске где-либо ещё нужно самому задать переменную AI_GATEWAY_API_KEY в файле .env.local.
Есть ли подводные камни при настройке, о которых стоит знать?Обязательно заполните переменные окружения из файла .env.example и никогда не добавляйте свой файл .env в репозиторий — в нём лежат секреты, которые позволяют посторонним получить контроль над вашим ИИ и аккаунтами авторизации.
Можно развернуть его в один клик?Да — в разделе Deploy Your Own можно развернуть свою копию Chatbot на Vercel одним нажатием.
А можно использовать провайдеров, которых нет в AI Gateway?Да — поменяв всего несколько строк кода, можно переключить AI SDK на подключение напрямую к провайдерам LLM, например OpenAI, Anthropic или Cohere.
На чём сделан интерфейс?На компонентах shadcn/ui со стилями Tailwind CSS, а в их основе лежат примитивы Radix UI для доступности и гибкости.
What are similar projects?crm, taxonomy, saas-starter, react-starter-kit, LibreChat, rankme.fast, NextChat, scira
Which topics is it in?xai, radix-ui, mistral, drizzle-orm, llm-gateway, shadcn-ui, vercel, full-stack, template, tailwindcss, chatgpt, redis
Creator
vercel
Size
6.2 MB
Stars
21K
Updated
CommitJul 08
Age
3y
Commits · 90 Days