https://github.com/theexplainthis/ai-chatbot

https://github.com/theexplainthis/ai-chatbot

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/theexplainthis/ai-chatbot
• Owner: TheExplainthis
• License: other
• Created: 2023-07-24T14:17:03.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-24T14:39:42.000Z (almost 2 years ago)
• Last Synced: 2023-08-20T22:54:43.483Z (over 1 year ago)
• Language: TypeScript
• Size: 141 KB
• Stars: 2
• Watchers: 1
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
ExplainThis AI Chatbot






  An open-source AI chatbot app template built with Next.js, the Vercel AI SDK, OpenAI, and React Query.





  Features ·

  Deploy Your Own ·

  Running locally ·






## 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)

## Deploy Your Own

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

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FTheExplainthis%2Fai-chatbot&env=NEXT_PUBLIC_APP_NAME,NEXT_PUBLIC_API_BASE_URL,NEXT_PUBLIC_LOGO_URL,NEXT_PUBLIC_EMPTY_SCREEN_TITLE,NEXT_PUBLIC_EMPTY_SCREEN_DESC&project-name=ai-chatbot&repository-name=my-ai-chatbot&demo-title=AI%20%E8%81%8A%E5%A4%A9%E6%A9%9F%E5%99%A8%E4%BA%BA&demo-description=AI%20%E8%81%8A%E5%A4%A9%E6%A9%9F%E5%99%A8%E4%BA%BA)

## Running locally

You will need to use the environment variables [defined in `.env.example`](.env.example) to run this 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/).