blanchon commited on
Commit
830b0b6
1 Parent(s): 545f27c

Feature customizable description (#507)

Browse files

* Add PUBLIC_APP_DESCRIPTION to .env

* Add PUBLIC_APP_DESCRIPTION to .env.template

* Add PUBLIC_APP_DESCRIPTION example in README.md

* Make description customizable using PUBLIC_APP_DESCRIPTION

* Fix bad quote in the `.env` example

.env CHANGED
@@ -85,6 +85,7 @@ MESSAGES_BEFORE_LOGIN=# how many messages a user can send in a conversation befo
85
  PUBLIC_APP_NAME=ChatUI # name used as title throughout the app
86
  PUBLIC_APP_ASSETS=chatui # used to find logos & favicons in static/$PUBLIC_APP_ASSETS
87
  PUBLIC_APP_COLOR=blue # can be any of tailwind colors: https://tailwindcss.com/docs/customizing-colors#default-color-palette
 
88
  PUBLIC_APP_DATA_SHARING=#set to 1 to enable options & text regarding data sharing
89
  PUBLIC_APP_DISCLAIMER=#set to 1 to show a disclaimer on login page
90
  LLM_SUMMERIZATION=true
@@ -92,5 +93,6 @@ LLM_SUMMERIZATION=true
92
  # PUBLIC_APP_NAME=HuggingChat
93
  # PUBLIC_APP_ASSETS=huggingchat
94
  # PUBLIC_APP_COLOR=yellow
 
95
  # PUBLIC_APP_DATA_SHARING=1
96
  # PUBLIC_APP_DISCLAIMER=1
 
85
  PUBLIC_APP_NAME=ChatUI # name used as title throughout the app
86
  PUBLIC_APP_ASSETS=chatui # used to find logos & favicons in static/$PUBLIC_APP_ASSETS
87
  PUBLIC_APP_COLOR=blue # can be any of tailwind colors: https://tailwindcss.com/docs/customizing-colors#default-color-palette
88
+ PUBLIC_APP_DESCRIPTION=# description used throughout the app (if not set, a default one will be used)
89
  PUBLIC_APP_DATA_SHARING=#set to 1 to enable options & text regarding data sharing
90
  PUBLIC_APP_DISCLAIMER=#set to 1 to show a disclaimer on login page
91
  LLM_SUMMERIZATION=true
 
93
  # PUBLIC_APP_NAME=HuggingChat
94
  # PUBLIC_APP_ASSETS=huggingchat
95
  # PUBLIC_APP_COLOR=yellow
96
+ # PUBLIC_APP_DESCRIPTION="Making the community's best AI chat models available to everyone."
97
  # PUBLIC_APP_DATA_SHARING=1
98
  # PUBLIC_APP_DISCLAIMER=1
.env.template CHANGED
@@ -141,6 +141,7 @@ PUBLIC_ANNOUNCEMENT_BANNERS=`[
141
  PUBLIC_APP_NAME=HuggingChat
142
  PUBLIC_APP_ASSETS=huggingchat
143
  PUBLIC_APP_COLOR=yellow
 
144
  PUBLIC_APP_DATA_SHARING=1
145
  PUBLIC_APP_DISCLAIMER=1
146
 
 
141
  PUBLIC_APP_NAME=HuggingChat
142
  PUBLIC_APP_ASSETS=huggingchat
143
  PUBLIC_APP_COLOR=yellow
144
+ PUBLIC_APP_DESCRIPTION="Making the community's best AI chat models available to everyone."
145
  PUBLIC_APP_DATA_SHARING=1
146
  PUBLIC_APP_DISCLAIMER=1
147
 
README.md CHANGED
@@ -104,6 +104,7 @@ You can use a few environment variables to customize the look and feel of chat-u
104
  PUBLIC_APP_NAME=ChatUI
105
  PUBLIC_APP_ASSETS=chatui
106
  PUBLIC_APP_COLOR=blue
 
107
  PUBLIC_APP_DATA_SHARING=
108
  PUBLIC_APP_DISCLAIMER=
109
  ```
 
104
  PUBLIC_APP_NAME=ChatUI
105
  PUBLIC_APP_ASSETS=chatui
106
  PUBLIC_APP_COLOR=blue
107
+ PUBLIC_APP_DESCRIPTION="Making the community's best AI chat models available to everyone."
108
  PUBLIC_APP_DATA_SHARING=
109
  PUBLIC_APP_DISCLAIMER=
110
  ```
src/lib/components/chat/ChatIntroduction.svelte CHANGED
@@ -1,6 +1,7 @@
1
  <script lang="ts">
2
  import { PUBLIC_APP_NAME, PUBLIC_VERSION } from "$env/static/public";
3
  import { PUBLIC_ANNOUNCEMENT_BANNERS } from "$env/static/public";
 
4
  import Logo from "$lib/components/icons/Logo.svelte";
5
  import { createEventDispatcher } from "svelte";
6
  import IconChevron from "$lib/components/icons/IconChevron.svelte";
@@ -40,7 +41,8 @@
40
  </div>
41
  </div>
42
  <p class="text-base text-gray-600 dark:text-gray-400">
43
- Making the community's best AI chat models available to everyone.
 
44
  </p>
45
  </div>
46
  </div>
 
1
  <script lang="ts">
2
  import { PUBLIC_APP_NAME, PUBLIC_VERSION } from "$env/static/public";
3
  import { PUBLIC_ANNOUNCEMENT_BANNERS } from "$env/static/public";
4
+ import { PUBLIC_APP_DESCRIPTION } from "$env/static/public";
5
  import Logo from "$lib/components/icons/Logo.svelte";
6
  import { createEventDispatcher } from "svelte";
7
  import IconChevron from "$lib/components/icons/IconChevron.svelte";
 
41
  </div>
42
  </div>
43
  <p class="text-base text-gray-600 dark:text-gray-400">
44
+ {PUBLIC_APP_DESCRIPTION ||
45
+ "Making the community's best AI chat models available to everyone."}
46
  </p>
47
  </div>
48
  </div>