{"id":24548201,"url":"https://github.com/flanker/chatbot-ui","last_synced_at":"2025-03-16T11:20:48.519Z","repository":{"id":232785880,"uuid":"623914866","full_name":"flanker/chatbot-ui","owner":"flanker","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-05T11:04:37.000Z","size":501,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-22T23:16:16.892Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://chatbot-ui-flankerfc.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flanker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-04-05T11:04:20.000Z","updated_at":"2023-04-23T00:22:31.000Z","dependencies_parsed_at":"2024-04-11T13:01:19.630Z","dependency_job_id":"54375fc2-447c-4031-8274-0ac50d094b9d","html_url":"https://github.com/flanker/chatbot-ui","commit_stats":null,"previous_names":["flanker/chatbot-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanker%2Fchatbot-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanker%2Fchatbot-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanker%2Fchatbot-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanker%2Fchatbot-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flanker","download_url":"https://codeload.github.com/flanker/chatbot-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858573,"owners_count":20359375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-22T23:16:23.472Z","updated_at":"2025-03-16T11:20:48.494Z","avatar_url":"https://github.com/flanker.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chatbot UI\n\nChatbot UI is an advanced chatbot kit for OpenAI's chat models built on top of [Chatbot UI Lite](https://github.com/mckaywrigley/chatbot-ui-lite) using Next.js, TypeScript, and Tailwind CSS.\n\nSee a [demo](https://twitter.com/mckaywrigley/status/1640380021423603713?s=46\u0026t=AowqkodyK6B4JccSOxSPew).\n\n![Chatbot UI](./public/screenshot.png)\n\n## Updates\n\nChatbot UI will be updated over time.\n\nExpect frequent improvements.\n\n**Next up:**\n\n- [ ] Delete messages\n- [ ] More model settings\n- [ ] Plugins\n\n**Recent updates:**\n\n- [x] Prompt templates (3/27/23)\n- [x] Regenerate \u0026 edit responses (3/25/23)\n- [x] Folders (3/24/23)\n- [x] Search chat content (3/23/23)\n- [x] Stop message generation (3/22/23)\n- [x] Import/Export chats (3/22/23)\n- [x] Custom system prompt (3/21/23)\n- [x] Error handling (3/20/23)\n- [x] GPT-4 support (access required) (3/20/23)\n- [x] Search conversations (3/19/23)\n- [x] Code syntax highlighting (3/18/23)\n- [x] Toggle sidebar (3/18/23)\n- [x] Conversation naming (3/18/23)\n- [x] Github flavored markdown (3/18/23)\n- [x] Add OpenAI API key in app (3/18/23)\n- [x] Markdown support (3/17/23)\n\n## Modifications\n\nModify the chat interface in `components/Chat`.\n\nModify the sidebar interface in `components/Sidebar`.\n\nModify the system prompt in `utils/index.ts`.\n\n## Deploy\n\n**Vercel**\n\nHost your own live version of Chatbot UI with Vercel.\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmckaywrigley%2Fchatbot-ui)\n\n**Replit**\n\nFork Chatbot UI on Replit [here](https://replit.com/@MckayWrigley/chatbot-ui-pro?v=1).\n\n**Docker**\n\nBuild locally:\n\n```shell\ndocker build -t chatgpt-ui .\ndocker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 chatgpt-ui\n```\n\nPull from ghcr:\n\n```\ndocker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 ghcr.io/mckaywrigley/chatbot-ui:main\n```\n\n## Running Locally\n\n**1. Clone Repo**\n\n```bash\ngit clone https://github.com/mckaywrigley/chatbot-ui.git\n```\n\n**2. Install Dependencies**\n\n```bash\nnpm i\n```\n\n**3. Provide OpenAI API Key**\n\nCreate a .env.local file in the root of the repo with your OpenAI API Key:\n\n```bash\nOPENAI_API_KEY=YOUR_KEY\n```\n\n\u003e You can set `OPENAI_API_HOST` where access to the official OpenAI host is restricted or unavailable, allowing users to configure an alternative host for their specific needs.\n\n\u003e Additionally, if you have multiple OpenAI Organizations, you can set `OPENAI_ORGANIZATION` to specify one.\n\n**4. Run App**\n\n```bash\nnpm run dev\n```\n\n**5. Use It**\n\nYou should be able to start chatting.\n\n## Configuration\n\nWhen deploying the application, the following environment variables can be set:\n\n| Environment Variable  | Default value                  | Description                                             |\n| --------------------- | ------------------------------ | ------------------------------------------------------- |\n| OPENAI_API_KEY        |                                | The default API key used for authentication with OpenAI |\n| DEFAULT_MODEL         | `gpt-3.5-turbo`                | The default model to use on new conversations           |\n| DEFAULT_SYSTEM_PROMPT | [see here](utils/app/const.ts) | The default system prompt to use on new conversations   |\n| GOOGLE_API_KEY        |                                | See [Custom Search JSON API documentation][GCSE]        |\n| GOOGLE_CSE_ID         |                                | See [Custom Search JSON API documentation][GCSE]        |\n\nIf you do not provide an OpenAI API key with `OPENAI_API_KEY`, users will have to provide their own key.\nIf you don't have an OpenAI API key, you can get one [here](https://platform.openai.com/account/api-keys).\n\n## Contact\n\nIf you have any questions, feel free to reach out to me on [Twitter](https://twitter.com/mckaywrigley).\n\n[GCSE]: https://developers.google.com/custom-search/v1/overview\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflanker%2Fchatbot-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflanker%2Fchatbot-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflanker%2Fchatbot-ui/lists"}