chatbot-ui

Chatbot UI

Chatbot UI is an open-source AI chat application designed for everyone. It’s user-friendly and easy to access for those interested in utilizing AI for communication.

Demo

You can check out a demo to see Chatbot UI in action here.

Updates

The creator, Mckay, is actively working on a major update, focusing on simplifying deployment, enhancing backend compatibility, and refining mobile layouts. These improvements are on the horizon.

Official Hosted Version

For those who prefer not to host themselves, there’s an official version available here.

Sponsor

If Chatbot UI proves beneficial, consider sponsoring to support ongoing open-source work.

Issues and Discussions

"Issues" are strictly for codebase-related problems. For general queries or feature requests, users are encouraged to visit the "Discussions" tab to ask questions and exchange ideas. Many questions you might have may already be answered in this section.

Legacy Code

Documentation for version 1.0 is available on the legacy branch, as Chatbot UI has been updated to version 2.0.

Updating

To keep your local version updated, use:

npm run update

For hosted instances, remember also to apply database migrations with:

npm run db-push

Local Quickstart

Follow these steps to set up Chatbot UI on your local machine.

1. Clone the Repository

   git clone https://github.com/mckaywrigley/chatbot-ui.git
   

2. Install Dependencies

   In your terminal, run:

   npm install
   

3. Install and Start Supabase

   • Install Docker if you haven’t already (download here).

   • Install Supabase CLI:

     MacOS/Linux

     brew install supabase/tap/supabase
     

     Windows

     scoop bucket add supabase https://github.com/supabase/scoop-bucket.git
     scoop install supabase
     

   • Start Supabase:

     supabase start
     

4. Fill in Secrets

   Copy environment variables template and fill them out:

   cp .env.local.example .env.local
   

   Run:

   supabase status
   

5. Install Ollama (Optional for Local Models)

   Follow instructions here.

6. Run App Locally

   Start the application by running:

   npm run chat
   

   Access it at http://localhost:3000.

Hosted Quickstart

To host Chatbot UI in the cloud, follow the below steps:

1. Set Up Backend with Supabase

   Create a new project on Supabase and obtain your project values for environment setup.

   Configure authentication by enabling email.

2. Connect to Hosted Database

   Link your project and push your database using Supabase CLI commands.

3. Setup Frontend with Vercel

   Create a new project on Vercel by importing your GitHub repository. Adjust environment variables as needed and deploy.

Once your setup is complete, you can enjoy Chatbot UI on the provided Vercel URL. This guide provides a straightforward pathway to leverage the potential of an AI-driven chat application in various environments—locally or hosted.