Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jianyuan/sveltekit-ai-chatbot

A full-featured, hackable SvelteKit AI chatbot
https://github.com/jianyuan/sveltekit-ai-chatbot

ai openai svelte sveltekit vercel

Last synced: 6 days ago
JSON representation

A full-featured, hackable SvelteKit AI chatbot

Awesome Lists containing this project

README 

        


SvelteKit AI Chatbot







  An open-source AI chatbot app template built with SvelteKit, the Vercel AI SDK, OpenAI, and Vercel KV.






  Features ·

  Model Providers ·

  Deploy Your Own ·

  Running locally ·

  Authors







This is an **unofficial** SvelteKit port of [vercel-labs/ai-chatbot](https://github.com/vercel-labs/ai-chatbot).



## Support Development



If you find this template useful, please consider supporting me through GitHub Sponsorship or Ko-Fi to help with its development.



[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/jianyuan)

[![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/L3L71DQEL)



## Features



- [SvelteKit](https://kit.svelte.dev)

- [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) and [shadcn-svelte](https://github.com/huntabyte/shadcn-svelte)

  - Styling with [Tailwind CSS](https://tailwindcss.com)

  - [Radix Svelte](https://www.radix-svelte.com) and [Svelte Headless UI](https://svelte-headlessui.goss.io) 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) (🚧 Under construction)

- [Auth.js](https://authjs.dev) 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), you can switch 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:



[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-name=sveltekit-chat&repository-url=https%3A%2F%2Fgithub.com%2Fjianyuan%2Fsveltekit-ai-chatbot&env=OPENAI_API_KEY,AUTH_SECRET,GITHUB_ID,GITHUB_SECRET&envDescription=How%20to%20get%20these%20env%20vars&envLink=https%3A%2F%2Fgithub.com%2Fjianyuan%2Fsveltekit-ai-chatbot%2Fblob%2Fmain%2F.env.example&demo-title=SvelteKit%20Chat&demo-description=A%20full-featured%2C%20hackable%20SvelteKit%20AI%20chatbot&demo-url=https%3A%2F%2Fsveltekit-ai-chatbot.vercel.app&stores=%5B%7B%22type%22:%22kv%22%7D%5D)



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



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

npm install



npm run dev

# or start the server and open the app in a new browser tab

npm run dev -- --open

```



Your app template should now be running on [localhost:5173](http://localhost:5173/).



## Authors



This template is heavily based on the [Next.js version](https://github.com/vercel-labs/ai-chatbot), with contributions from:



- Jian Yuan Lee ([@jyuan](https://twitter.com/jyuan))