readme update
This commit is contained in:
parent
c959264f93
commit
c7be45587f
20
README.md
20
README.md
|
@ -1,6 +1,6 @@
|
||||||
# Chatbot UI
|
# Chatbot UI
|
||||||
|
|
||||||
Chatbot 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.
|
Chatbot UI is an open source chat UI for AI models.
|
||||||
|
|
||||||
See a [demo](https://twitter.com/mckaywrigley/status/1640380021423603713?s=46&t=AowqkodyK6B4JccSOxSPew).
|
See a [demo](https://twitter.com/mckaywrigley/status/1640380021423603713?s=46&t=AowqkodyK6B4JccSOxSPew).
|
||||||
|
|
||||||
|
@ -14,17 +14,8 @@ Expect frequent improvements.
|
||||||
|
|
||||||
**Next up:**
|
**Next up:**
|
||||||
|
|
||||||
- [ ] Import/Export prompts
|
|
||||||
- [ ] "Bots"
|
|
||||||
- [ ] Sharing
|
- [ ] Sharing
|
||||||
|
- [ ] "Bots"
|
||||||
## Modifications
|
|
||||||
|
|
||||||
Modify the chat interface in `components/Chat`.
|
|
||||||
|
|
||||||
Modify the sidebar interface in `components/Sidebar`.
|
|
||||||
|
|
||||||
Modify the system prompt in `utils/server/index.ts`.
|
|
||||||
|
|
||||||
## Deploy
|
## Deploy
|
||||||
|
|
||||||
|
@ -34,10 +25,6 @@ Host your own live version of Chatbot UI with Vercel.
|
||||||
|
|
||||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmckaywrigley%2Fchatbot-ui)
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmckaywrigley%2Fchatbot-ui)
|
||||||
|
|
||||||
**Replit**
|
|
||||||
|
|
||||||
Fork Chatbot UI on Replit [here](https://replit.com/@MckayWrigley/chatbot-ui-pro?v=1).
|
|
||||||
|
|
||||||
**Docker**
|
**Docker**
|
||||||
|
|
||||||
Build locally:
|
Build locally:
|
||||||
|
@ -108,10 +95,11 @@ When deploying the application, the following environment variables can be set:
|
||||||
| GOOGLE_CSE_ID | | See [Custom Search JSON API documentation][GCSE] |
|
| GOOGLE_CSE_ID | | See [Custom Search JSON API documentation][GCSE] |
|
||||||
|
|
||||||
If you do not provide an OpenAI API key with `OPENAI_API_KEY`, users will have to provide their own key.
|
If you do not provide an OpenAI API key with `OPENAI_API_KEY`, users will have to provide their own key.
|
||||||
|
|
||||||
If you don't have an OpenAI API key, you can get one [here](https://platform.openai.com/account/api-keys).
|
If you don't have an OpenAI API key, you can get one [here](https://platform.openai.com/account/api-keys).
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
If you have any questions, feel free to reach out to me on [Twitter](https://twitter.com/mckaywrigley).
|
If you have any questions, feel free to reach out to Mckay on [Twitter](https://twitter.com/mckaywrigley).
|
||||||
|
|
||||||
[GCSE]: https://developers.google.com/custom-search/v1/overview
|
[GCSE]: https://developers.google.com/custom-search/v1/overview
|
||||||
|
|
Loading…
Reference in New Issue