Silke pilon commited on
Commit
defe2f7
·
1 Parent(s): 68d73cd

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -67
README.md CHANGED
@@ -1,69 +1,7 @@
1
  ---
2
- title: chat-ui
3
- emoji: 🔥
4
- colorFrom: purple
5
- colorTo: purple
6
  sdk: docker
7
- pinned: false
8
- license: apache-2.0
9
- base_path: /chat
10
- app_port: 3000
11
- duplicated_from: huggingchat/chat-ui
12
- ---
13
-
14
- # Chat UI
15
-
16
- A chat interface using open source models, eg OpenAssistant.
17
-
18
- ## Launch
19
-
20
- ```bash
21
- npm install
22
- npm run dev
23
- ```
24
-
25
- ## Environment
26
-
27
- Default configuration is in `.env`. Put custom config and secrets in `.env.local`, it will override the values in `.env`.
28
-
29
- Check out [.env](./.env) to see what needs to be set.
30
-
31
- Basically you need to create a `.env.local` with the following contents:
32
-
33
- ```
34
- MONGODB_URL=<url to mongo, for example a free MongoDB Atlas sandbox instance>
35
- MODEL_ENDPOINTS=`[{
36
- "endpoint": "https://api-inference.huggingface.co/models/OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
37
- "authorization": "Bearer <hf_token>",
38
- "weight": 1
39
- }]`
40
- ```
41
-
42
- Where the contents in `<...>` are replaced by the MongoDB URL and your [HF Access Token](https://huggingface.co/settings/tokens).
43
-
44
- ## Duplicating to a Space
45
-
46
- Create a `DOTENV_LOCAL` secret to your space with the following contents:
47
-
48
- ```
49
- MONGODB_URL=<url to mongo, for example a free MongoDB Atlas sandbox instance>
50
- MODEL_ENDPOINTS=`[{
51
- "endpoint": "https://api-inference.huggingface.co/models/OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
52
- "authorization": "Bearer <hf_token>",
53
- "weight": 1
54
- }]`
55
- ```
56
-
57
- Where the contents in `<...>` are replaced by the MongoDB URL and your [HF Access Token](https://huggingface.co/settings/tokens).
58
-
59
- ## Building
60
-
61
- To create a production version of your app:
62
-
63
- ```bash
64
- npm run build
65
- ```
66
-
67
- You can preview the production build with `npm run preview`.
68
-
69
- > To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
 
1
  ---
2
+ title: BetterChat
 
 
 
3
  sdk: docker
4
+ emoji:
5
+ colorTo: blue
6
+ pinned: true
7
+ ---