Spaces:
Runtime error
Runtime error
Commit
•
61492d2
1
Parent(s):
b202e70
Update README.md
Browse files
README.md
CHANGED
|
@@ -2,116 +2,12 @@
|
|
| 2 |
sdk: docker
|
| 3 |
app_port: 3000
|
| 4 |
title: starchat-ui
|
| 5 |
-
emoji:
|
| 6 |
colorFrom: pink
|
| 7 |
colorTo: blue
|
| 8 |
duplicated_from: matthoffner/chatbot
|
| 9 |
---
|
| 10 |
|
| 11 |
-
Forked chat-bot
|
| 12 |
-
|
| 13 |
# Starchat Alpha UI
|
| 14 |
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
See a [demo](https://twitter.com/mckaywrigley/status/1640380021423603713?s=46&t=AowqkodyK6B4JccSOxSPew).
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
## Updates
|
| 22 |
-
|
| 23 |
-
Chatbot UI will be updated over time.
|
| 24 |
-
|
| 25 |
-
Expect frequent improvements.
|
| 26 |
-
|
| 27 |
-
**Next up:**
|
| 28 |
-
|
| 29 |
-
- [ ] Sharing
|
| 30 |
-
- [ ] "Bots"
|
| 31 |
-
|
| 32 |
-
## Deploy
|
| 33 |
-
|
| 34 |
-
**Vercel**
|
| 35 |
-
|
| 36 |
-
Host your own live version of Chatbot UI with Vercel.
|
| 37 |
-
|
| 38 |
-
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmckaywrigley%2Fchatbot-ui)
|
| 39 |
-
|
| 40 |
-
**Docker**
|
| 41 |
-
|
| 42 |
-
Build locally:
|
| 43 |
-
|
| 44 |
-
```shell
|
| 45 |
-
docker build -t chatgpt-ui .
|
| 46 |
-
docker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 chatgpt-ui
|
| 47 |
-
```
|
| 48 |
-
|
| 49 |
-
Pull from ghcr:
|
| 50 |
-
|
| 51 |
-
```
|
| 52 |
-
docker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 ghcr.io/mckaywrigley/chatbot-ui:main
|
| 53 |
-
```
|
| 54 |
-
|
| 55 |
-
## Running Locally
|
| 56 |
-
|
| 57 |
-
**1. Clone Repo**
|
| 58 |
-
|
| 59 |
-
```bash
|
| 60 |
-
git clone https://github.com/mckaywrigley/chatbot-ui.git
|
| 61 |
-
```
|
| 62 |
-
|
| 63 |
-
**2. Install Dependencies**
|
| 64 |
-
|
| 65 |
-
```bash
|
| 66 |
-
npm i
|
| 67 |
-
```
|
| 68 |
-
|
| 69 |
-
**3. Provide OpenAI API Key**
|
| 70 |
-
|
| 71 |
-
Create a .env.local file in the root of the repo with your OpenAI API Key:
|
| 72 |
-
|
| 73 |
-
```bash
|
| 74 |
-
OPENAI_API_KEY=YOUR_KEY
|
| 75 |
-
```
|
| 76 |
-
|
| 77 |
-
> 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.
|
| 78 |
-
|
| 79 |
-
> Additionally, if you have multiple OpenAI Organizations, you can set `OPENAI_ORGANIZATION` to specify one.
|
| 80 |
-
|
| 81 |
-
**4. Run App**
|
| 82 |
-
|
| 83 |
-
```bash
|
| 84 |
-
npm run dev
|
| 85 |
-
```
|
| 86 |
-
|
| 87 |
-
**5. Use It**
|
| 88 |
-
|
| 89 |
-
You should be able to start chatting.
|
| 90 |
-
|
| 91 |
-
## Configuration
|
| 92 |
-
|
| 93 |
-
When deploying the application, the following environment variables can be set:
|
| 94 |
-
|
| 95 |
-
| Environment Variable | Default value | Description |
|
| 96 |
-
| --------------------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
| 97 |
-
| OPENAI_API_KEY | | The default API key used for authentication with OpenAI |
|
| 98 |
-
| OPENAI_API_HOST | `https://api.openai.com` | The base url, for Azure use `https://<endpoint>.openai.azure.com` |
|
| 99 |
-
| OPENAI_API_TYPE | `openai` | The API type, options are `openai` or `azure` |
|
| 100 |
-
| OPENAI_API_VERSION | `2023-03-15-preview` | Only applicable for Azure OpenAI |
|
| 101 |
-
| AZURE_DEPLOYMENT_ID | | Needed when Azure OpenAI, Ref [Azure OpenAI API](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/reference#completions) |
|
| 102 |
-
| OPENAI_ORGANIZATION | | Your OpenAI organization ID |
|
| 103 |
-
| DEFAULT_MODEL | `gpt-3.5-turbo` | The default model to use on new conversations, for Azure use `gpt-35-turbo` |
|
| 104 |
-
| NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT | [see here](utils/app/const.ts) | The default system prompt to use on new conversations |
|
| 105 |
-
| NEXT_PUBLIC_DEFAULT_TEMPERATURE | 1 | The default temperature to use on new conversations |
|
| 106 |
-
| GOOGLE_API_KEY | | See [Custom Search JSON API documentation][GCSE] |
|
| 107 |
-
| GOOGLE_CSE_ID | | See [Custom Search JSON API documentation][GCSE] |
|
| 108 |
-
|
| 109 |
-
If you do not provide an OpenAI API key with `OPENAI_API_KEY`, users will have to provide their own key.
|
| 110 |
-
|
| 111 |
-
If you don't have an OpenAI API key, you can get one [here](https://platform.openai.com/account/api-keys).
|
| 112 |
-
|
| 113 |
-
## Contact
|
| 114 |
-
|
| 115 |
-
If you have any questions, feel free to reach out to Mckay on [Twitter](https://twitter.com/mckaywrigley).
|
| 116 |
-
|
| 117 |
-
[GCSE]: https://developers.google.com/custom-search/v1/overview
|
|
|
|
| 2 |
sdk: docker
|
| 3 |
app_port: 3000
|
| 4 |
title: starchat-ui
|
| 5 |
+
emoji: 🌞
|
| 6 |
colorFrom: pink
|
| 7 |
colorTo: blue
|
| 8 |
duplicated_from: matthoffner/chatbot
|
| 9 |
---
|
| 10 |
|
|
|
|
|
|
|
| 11 |
# Starchat Alpha UI
|
| 12 |
|
| 13 |
+
Forked chatbot from forked chatbot-ui
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|