From 8419b8df1e2df28d0fe6276b8083c06574bc8004 Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Sun, 11 Jun 2023 10:25:51 -0400 Subject: [PATCH] Add a readme --- .env.example | 2 ++ README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..ac5e5ce --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +OPENAI_API_KEY=XXXXXXXX +NEXTAUTH_SECRET=XXXXXXXX diff --git a/README.md b/README.md index a9b83db..247c999 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ # Next.js AI Chatbot -A an AI-powered Chatbot built with Next.js built by Vercel Labs. +A Next.js 13 and App Router-ready AI chatbot template featuring: + +- [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 +- Chat History, rate limiting, and session storage with [Vercel KV](https://vercel.com/storage/kv) +- [Next Auth](https://github.com/nextauthjs/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. + +## 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) + +[Contributors](https://github.com/vercel-labs/ai-chatbot/graphs/contributors)