@lobehub/chat 0.129.1 → 0.129.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/README.md +154 -85
  3. package/README.zh-CN.md +155 -80
  4. package/contributing/Basic/Add-New-Authentication-Providers.md +108 -0
  5. package/contributing/Basic/Add-New-Authentication-Providers.zh-CN.md +109 -0
  6. package/docs/self-hosting/examples/ollama.mdx +21 -0
  7. package/docs/self-hosting/examples/ollama.zh-CN.mdx +21 -0
  8. package/docs/usage/features/agent-market.mdx +9 -3
  9. package/docs/usage/features/agent-market.zh-CN.mdx +7 -1
  10. package/docs/usage/features/local-llm.mdx +5 -1
  11. package/docs/usage/features/local-llm.zh-CN.mdx +5 -1
  12. package/docs/usage/features/mobile.mdx +5 -1
  13. package/docs/usage/features/mobile.zh-CN.mdx +5 -1
  14. package/docs/usage/features/multi-ai-providers.mdx +5 -1
  15. package/docs/usage/features/multi-ai-providers.zh-CN.mdx +5 -1
  16. package/docs/usage/features/plugin-system.mdx +8 -7
  17. package/docs/usage/features/plugin-system.zh-CN.mdx +8 -7
  18. package/docs/usage/features/pwa.mdx +5 -1
  19. package/docs/usage/features/pwa.zh-CN.mdx +5 -1
  20. package/docs/usage/features/text-to-image.mdx +7 -1
  21. package/docs/usage/features/text-to-image.zh-CN.mdx +7 -1
  22. package/docs/usage/features/theme.mdx +5 -1
  23. package/docs/usage/features/theme.zh-CN.mdx +5 -1
  24. package/docs/usage/features/tts.mdx +7 -1
  25. package/docs/usage/features/tts.zh-CN.mdx +7 -1
  26. package/docs/usage/features/vision.mdx +7 -1
  27. package/docs/usage/features/vision.zh-CN.mdx +7 -1
  28. package/docs/usage/plugins/basic-usage.mdx +3 -10
  29. package/docs/usage/plugins/basic-usage.zh-CN.mdx +1 -7
  30. package/docs/usage/plugins/custom-plugin.mdx +2 -9
  31. package/docs/usage/plugins/custom-plugin.zh-CN.mdx +1 -7
  32. package/docs/usage/providers/ollama.mdx +80 -0
  33. package/docs/usage/providers/ollama.zh-CN.mdx +80 -0
  34. package/package.json +4 -4
  35. package/src/app/api/auth/next-auth.ts +28 -0
  36. package/src/components/ModelIcon/index.tsx +2 -0
  37. package/src/components/ModelTag/ModelIcon.tsx +2 -0
  38. package/src/config/modelProviders/ollama.ts +22 -0
package/CHANGELOG.md CHANGED
@@ -2,6 +2,56 @@
2
2
 
3
3
  # Changelog
4
4
 
5
+ ### [Version 0.129.3](https://github.com/lobehub/lobe-chat/compare/v0.129.2...v0.129.3)
6
+
7
+ <sup>Released on **2024-02-23**</sup>
8
+
9
+ #### 💄 Styles
10
+
11
+ - **misc**: Add gemma model logo for ollama.
12
+
13
+ <br/>
14
+
15
+ <details>
16
+ <summary><kbd>Improvements and Fixes</kbd></summary>
17
+
18
+ #### Styles
19
+
20
+ - **misc**: Add gemma model logo for ollama, closes [#1369](https://github.com/lobehub/lobe-chat/issues/1369) ([e2fb3a3](https://github.com/lobehub/lobe-chat/commit/e2fb3a3))
21
+
22
+ </details>
23
+
24
+ <div align="right">
25
+
26
+ [![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
27
+
28
+ </div>
29
+
30
+ ### [Version 0.129.2](https://github.com/lobehub/lobe-chat/compare/v0.129.1...v0.129.2)
31
+
32
+ <sup>Released on **2024-02-23**</sup>
33
+
34
+ #### 🐛 Bug Fixes
35
+
36
+ - **misc**: Fix OAuth don't get user id from session.
37
+
38
+ <br/>
39
+
40
+ <details>
41
+ <summary><kbd>Improvements and Fixes</kbd></summary>
42
+
43
+ #### What's fixed
44
+
45
+ - **misc**: Fix OAuth don't get user id from session, closes [#1347](https://github.com/lobehub/lobe-chat/issues/1347) ([ce4d6ca](https://github.com/lobehub/lobe-chat/commit/ce4d6ca))
46
+
47
+ </details>
48
+
49
+ <div align="right">
50
+
51
+ [![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
52
+
53
+ </div>
54
+
5
55
  ### [Version 0.129.1](https://github.com/lobehub/lobe-chat/compare/v0.129.0...v0.129.1)
6
56
 
7
57
  <sup>Released on **2024-02-22**</sup>
package/README.md CHANGED
@@ -1,17 +1,14 @@
1
- <a name="readme-top"></a>
1
+ <div align="center"><a name="readme-top"></a>
2
2
 
3
- <div align="center">
4
-
5
- <img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
6
- <img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
7
- <img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji-anim/1.0.0/files/assets/robot.webp">
3
+ [![][image-banner]][vercel-link]
8
4
 
9
5
  # Lobe Chat
10
6
 
11
- LobeChat is an open-source, high-performance chatbot framework<br/>that supports speech synthesis, multimodal, and extensible ([Function Call][fc-link]) plugin system. <br/>
12
- Supports one-click free deployment of your private ChatGPT/LLM web application.
7
+ An open-source, modern-design ChatGPT/LLMs UI/Framework.<br/>
8
+ Supports speech-synthesis, multi-modal, and extensible ([function call][docs-functionc-call]) plugin system.<br/>
9
+ One-click **FREE** deployment of your private ChatGPT/Gemini/Ollama chat application.
13
10
 
14
- **English** · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) · [Documents][github-document-link] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
11
+ **English** · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) · [Documents][docs] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
15
12
 
16
13
  <!-- SHIELD GROUP -->
17
14
 
@@ -44,8 +41,7 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
44
41
 
45
42
  [![][github-trending-shield]][github-trending-url]
46
43
 
47
- ![](https://github.com/lobehub/lobe-chat/assets/28616219/9f155dff-4737-429f-9cad-a70a1a860c5f)
48
- ![](https://github.com/lobehub/lobe-chat/assets/28616219/8b04c3c9-3d71-4fb4-bd9b-a4f415c5876d)
44
+ [![][image-overview]][vercel-link]
49
45
 
50
46
  </div>
51
47
 
@@ -56,6 +52,17 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
56
52
 
57
53
  - [👋🏻 Getting Started & Join Our Community](#-getting-started--join-our-community)
58
54
  - [✨ Features](#-features)
55
+ - [`1` Multi-Model Service Provider Support](#1-multi-model-service-provider-support)
56
+ - [`2` Local Large Language Model (LLM) Support](#2-local-large-language-model-llm-support)
57
+ - [`3` Model Visual Recognition](#3-model-visual-recognition)
58
+ - [`4` TTS & STT Voice Conversation](#4-tts--stt-voice-conversation)
59
+ - [`5` Text to Image Generation](#5-text-to-image-generation)
60
+ - [`6` Plugin System (Function Calling)](#6-plugin-system-function-calling)
61
+ - [`7` Agent Market (GPTs)](#7-agent-market-gpts)
62
+ - [`8` Progressive Web App (PWA)](#8-progressive-web-app-pwa)
63
+ - [`9` Mobile Device Adaptation](#9-mobile-device-adaptation)
64
+ - [`10` Custom Themes](#10-custom-themes)
65
+ - [`*` What's more](#-whats-more)
59
66
  - [⚡️ Performance](#️-performance)
60
67
  - [🛳 Self Hosting](#-self-hosting)
61
68
  - [`A` Deploying with Vercel, Zeabur or Sealos](#a-deploying-with-vercel-zeabur-or-sealos)
@@ -65,7 +72,7 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
65
72
  - [🧩 Plugins](#-plugins)
66
73
  - [⌨️ Local Development](#️-local-development)
67
74
  - [🤝 Contributing](#-contributing)
68
- - [🩷 Sponsor](#-sponsor)
75
+ - [❤️ Sponsor](#️-sponsor)
69
76
  - [🔗 More Products](#-more-products)
70
77
 
71
78
  ####
@@ -76,7 +83,10 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
76
83
 
77
84
  ## 👋🏻 Getting Started & Join Our Community
78
85
 
79
- We are a group of e/acc design-engineers, hoping to provide modern design components and tools for AIGC. Whether for users or professional developers, LobeHub will be your AI Agent playground. Please be aware that LobeChat is currently under active development, and feedback is welcome for any [issues][issues-link] encountered.
86
+ We are a group of e/acc design-engineers, hoping to provide modern design components and tools for AIGC.
87
+ By adopting the Bootstrapping approach, we aim to provide developers and users with a more open, transparent, and user-friendly product ecosystem.
88
+
89
+ Whether for users or professional developers, LobeHub will be your AI Agent playground. Please be aware that LobeChat is currently under active development, and feedback is welcome for any [issues][issues-link] encountered.
80
90
 
81
91
  | [![][vercel-shield-badge]][vercel-link] | No installation or registration necessary! Visit our website to experience it firsthand. |
82
92
  | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
@@ -86,7 +96,7 @@ We are a group of e/acc design-engineers, hoping to provide modern design compon
86
96
  >
87
97
  > **Star Us**, You will receive all release notifications from GitHub without any delay \~ ⭐️
88
98
 
89
- ![](https://gw.alipayobjects.com/zos/kitchen/0hcO8QiU9c/star.webp)
99
+ [![][image-star]][github-stars-link]
90
100
 
91
101
  <details>
92
102
  <summary><kbd>Star History</kbd></summary>
@@ -98,9 +108,50 @@ We are a group of e/acc design-engineers, hoping to provide modern design compon
98
108
 
99
109
  ## ✨ Features
100
110
 
101
- ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072129-382bdf30-e3d6-4411-b5a0-249710b8ba08.png)
111
+ [![][image-feat-privoder]][docs-feat-provider]
112
+
113
+ ### `1` [Multi-Model Service Provider Support][docs-feat-provider]
114
+
115
+ In the continuous development of LobeChat, we deeply understand the importance of diversity in model service providers for meeting the needs of the community when providing AI conversation services. Therefore, we have expanded our support to multiple model service providers, rather than being limited to a single one, in order to offer users a more diverse and rich selection of conversations.
116
+
117
+ In this way, LobeChat can more flexibly adapt to the needs of different users, while also providing developers with a wider range of choices.
118
+
119
+ #### Supported Model Service Providers
120
+
121
+ We have implemented support for the following model service providers:
122
+
123
+ - **AWS Bedrock**: Integrated with AWS Bedrock service, supporting models such as **Claude / LLama2**, providing powerful natural language processing capabilities. [Learn more](https://aws.amazon.com/cn/bedrock)
124
+ - **Google AI (Gemini Pro, Gemini Vision)**: Access to Google's **Gemini** series models, including Gemini and Gemini Pro, to support advanced language understanding and generation. [Learn more](https://deepmind.google/technologies/gemini/)
125
+ - **ChatGLM**: Added the **ChatGLM** series models from Zhipuai (GLM-4/GLM-4-vision/GLM-3-turbo), providing users with another efficient conversation model choice. [Learn more](https://www.zhipuai.cn/)
126
+ - **Moonshot AI (Dark Side of the Moon)**: Integrated with the Moonshot series models, an innovative AI startup from China, aiming to provide deeper conversation understanding. [Learn more](https://www.moonshot.cn/)
127
+
128
+ At the same time, we are also planning to support more model service providers, such as Replicate and Perplexity, to further enrich our service provider library. If you would like LobeChat to support your favorite service provider, feel free to join our [community discussion](https://github.com/lobehub/lobe-chat/discussions/1284).
129
+
130
+ <div align="right">
102
131
 
103
- #### `1` Visual Model Support
132
+ [![][back-to-top]](#readme-top)
133
+
134
+ </div>
135
+
136
+ [![][image-feat-local]][docs-feat-local]
137
+
138
+ ### `2` [Local Large Language Model (LLM) Support][docs-feat-local]
139
+
140
+ To meet the specific needs of users, LobeChat also supports the use of local models based on [Ollama](https://ollama.ai), allowing users to flexibly use their own or third-party models.
141
+
142
+ > \[!TIP]
143
+ >
144
+ > Learn more about [📘 Using Ollama in LobeChat][docs-usage-ollama] by checking it out.
145
+
146
+ <div align="right">
147
+
148
+ [![][back-to-top]](#readme-top)
149
+
150
+ </div>
151
+
152
+ [![][image-feat-vision]][docs-feat-vision]
153
+
154
+ ### `3` [Model Visual Recognition][docs-feat-vision]
104
155
 
105
156
  LobeChat now supports OpenAI's latest [`gpt-4-vision`](https://platform.openai.com/docs/guides/vision) model with visual recognition capabilities,
106
157
  a multimodal intelligence that can perceive visuals. Users can easily upload or drag and drop images into the dialogue box,
@@ -116,9 +167,9 @@ Whether it's sharing images in daily use or interpreting images within specific
116
167
 
117
168
  </div>
118
169
 
119
- ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072124-c9853d8d-f1b5-44a8-a305-45ebc0f6d19a.png)
170
+ [![][image-feat-tts]][docs-feat-tts]
120
171
 
121
- #### `2` TTS & STT Voice Speech
172
+ ### `4` [TTS & STT Voice Conversation][docs-feat-tts]
122
173
 
123
174
  LobeChat supports Text-to-Speech (TTS) and Speech-to-Text (STT) technologies, enabling our application to convert text messages into clear voice outputs,
124
175
  allowing users to interact with our conversational agent as if they were talking to a real person. Users can choose from a variety of voices to pair with the agent.
@@ -127,28 +178,15 @@ Moreover, TTS offers an excellent solution for those who prefer auditory learnin
127
178
  In LobeChat, we have meticulously selected a range of high-quality voice options (OpenAI Audio, Microsoft Edge Speech) to meet the needs of users from different regions and cultural backgrounds.
128
179
  Users can choose the voice that suits their personal preferences or specific scenarios, resulting in a personalized communication experience.
129
180
 
130
- > \[!NOTE]
131
- >
132
- > In the process of implementing this feature, we found that there was no satisfactory TTS (Text-to-Speech) frontend library available on the market.
133
- > As a result, we invested a lot of effort, including data conversion, audio progress management, and speech visualization, among other tasks.
134
-
135
- > \[!IMPORTANT]
136
- >
137
- > Therefore, we decided to refine our implementation and make it open source, hoping to assist developers who wish to implement TTS.
138
- > [@lobehub/tts][lobe-tts-github] is a high-quality TTS toolkit developed in TypeScript, which supports usage both on the server-side and in the browser.
139
- >
140
- > - **Server-side:** With just 15 lines of code, you can achieve high-quality voice generation capabilities comparable to OpenAI's TTS service. It currently supports EdgeSpeechTTS, MicrosoftTTS, OpenAITTS, and OpenAISTT.
141
- > - **Browser-side:** It provides high-quality React Hooks and visual audio components, supporting common functions such as loading, playing, pausing, and dragging the timeline. Additionally, it offers a very rich set of capabilities for adjusting the audio track styles.
142
-
143
181
  <div align="right">
144
182
 
145
183
  [![][back-to-top]](#readme-top)
146
184
 
147
185
  </div>
148
186
 
149
- ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/297746445-0ff762b9-aa08-4337-afb7-12f932b6efbb.png)
187
+ [![][image-feat-t2i]][docs-feat-t2i]
150
188
 
151
- #### `3` Text to Image
189
+ ### `5` [Text to Image Generation][docs-feat-t2i]
152
190
 
153
191
  With support for the latest text-to-image generation technology, LobeChat now allows users to invoke image creation tools directly within conversations with the agent. By leveraging the capabilities of AI tools such as [`DALL-E 3`](https://openai.com/dall-e-3), [`MidJourney`](https://www.midjourney.com/), and [`Pollinations`](https://pollinations.ai/), the agents are now equipped to transform your ideas into images.
154
192
 
@@ -160,30 +198,21 @@ This enables a more private and immersive creative process, allowing for the sea
160
198
 
161
199
  </div>
162
200
 
163
- ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670883-33c43a5c-a512-467e-855c-fa299548cce5.png)
164
-
165
- #### `4` Function Calling Plugin System
201
+ [![][image-feat-plugin]][docs-feat-plugin]
166
202
 
167
- The plugin ecosystem of LobeChat is a significant extension of its core functionalities, greatly enhancing the practicality and flexibility of ChatGPT.
168
- By leveraging plugins, ChatGPT can perform real-time information retrieval and processing,
169
- such as automatically fetching the latest news headlines to provide users with immediate and relevant information.
170
- Moreover, these plugins are not limited to news aggregation but can also extend to other practical functions, such as quick document retrieval,
171
- e-commerce platform data access, and various third-party services.
203
+ ### `6` [Plugin System (Function Calling)][docs-feat-plugin]
172
204
 
173
- > Learn More in [📘 Plugin Usage](https://chat-docs.lobehub.com/en/usage/plugins/basic)
205
+ The plugin ecosystem of LobeChat is an important extension of its core functionality, greatly enhancing the practicality and flexibility of the LobeChat assistant.
174
206
 
175
207
  <video controls src="https://github.com/lobehub/lobe-chat/assets/28616219/f29475a3-f346-4196-a435-41a6373ab9e2" muted="false"></video>
176
208
 
177
- > \[!TIP]
178
- >
179
- > To aid developers in joining this ecosystem, we provide comprehensive development resources in the [🧩 Plugin System](#-plugins) section.
180
- > This includes detailed component development documentation,
181
- > a fully-featured software development kit (SDK), and template files—all designed to simplify the development process and lower the barrier to entry for developers.
209
+ By utilizing plugins, LobeChat assistants can obtain and process real-time information, such as searching for web information and providing users with instant and relevant news.
182
210
 
183
- > \[!IMPORTANT]
211
+ In addition, these plugins are not limited to news aggregation, but can also extend to other practical functions, such as quickly searching documents, generating images, obtaining data from various platforms like Bilibili, Steam, and interacting with various third-party services.
212
+
213
+ > \[!TIP]
184
214
  >
185
- > We welcome developers to use these resources to unleash their creativity and write feature-rich, user-friendly plugins.
186
- > With collective efforts, we can continuously expand the boundaries of chat applications and explore a more intelligent and efficient creativity platform.
215
+ > Learn more about [📘 Plugin Usage][docs-usage-plugin] by checking it out.
187
216
 
188
217
  <!-- PLUGIN LIST -->
189
218
 
@@ -204,11 +233,11 @@ e-commerce platform data access, and various third-party services.
204
233
 
205
234
  </div>
206
235
 
207
- ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670869-f1ffbf66-42b6-42cf-a937-9ce1f8328514.png)
236
+ [![][image-feat-agent]][docs-feat-agent]
208
237
 
209
- #### `5` Agent Market
238
+ ### `7` [Agent Market (GPTs)][docs-feat-agent]
210
239
 
211
- In the LobeChat Agent Marketplace, creators can discover a vibrant and innovative community that brings together a multitude of well-designed agents,
240
+ In LobeChat Agent Marketplace, creators can discover a vibrant and innovative community that brings together a multitude of well-designed agents,
212
241
  which not only play an important role in work scenarios but also offer great convenience in learning processes.
213
242
  Our marketplace is not just a showcase platform but also a collaborative space. Here, everyone can contribute their wisdom and share the agents they have developed.
214
243
 
@@ -226,12 +255,12 @@ Our marketplace is not just a showcase platform but also a collaborative space.
226
255
 
227
256
  <!-- AGENT LIST -->
228
257
 
229
- | Recent Submits | Description |
230
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
231
- | [Facebook Advertising Writing Expert](https://chat-preview.lobehub.com/market?agent=facebook-advertising-writing-expert)<br/><sup>By **[pllz7](https://github.com/pllz7)** on **2024-02-19**</sup> | Specializing in creating attention-grabbing headlines, compelling primary texts, and effective ad copy<br/>`facebook` `advertising` `writing` `expert` `ecommerce` |
232
- | [Jira Story Facilitator](https://chat-preview.lobehub.com/market?agent=jira-product-manager)<br/><sup>By **[emad-pg](https://github.com/emad-pg)** on **2024-02-19**</sup> | Specialized in transforming feature ideas into comprehensive Jira stories<br/>`technical-product-management` `story-creation` `jira` |
233
- | [ThinkTank360](https://chat-preview.lobehub.com/market?agent=think-tank-business-strategy)<br/><sup>By **[mikelix](https://github.com/mikelix)** on **2024-02-19**</sup> | Skilled consultant channeling wisdom of Steve Jobs, Elon Musk, MA Yun, Plato, and Ray Dalio for decision reviews, judgements, and advice.<br/>`innovation` `wisdom` `think-tank` `business-strategy` |
234
- | [Translation Specialist](https://chat-preview.lobehub.com/market?agent=translation-specialist)<br/><sup>By **[MYSeaIT](https://github.com/MYSeaIT)** on **2024-02-19**</sup> | Expert translator fluent in Spanish and English<br/>`translation` `language` `expert` `guidelines` |
258
+ | Recent Submits | Description |
259
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
260
+ | [LobeChat Technical Documentation Expert](https://chat-preview.lobehub.com/market?agent=lobe-chat-developer-document-writer)<br/><sup>By **[arvinxx](https://github.com/arvinxx)** on **2024-02-22**</sup> | LobeChat is an AI conversation application built with the Next.js framework. I will help you write the development documentation for LobeChat.<br/>`development-documentation` `technical-introduction` `next-js` `react` `lobe-chat` |
261
+ | [Facebook Advertising Writing Expert](https://chat-preview.lobehub.com/market?agent=facebook-advertising-writing-expert)<br/><sup>By **[pllz7](https://github.com/pllz7)** on **2024-02-19**</sup> | Specializing in creating attention-grabbing headlines, compelling primary texts, and effective ad copy<br/>`facebook` `advertising` `writing` `expert` `ecommerce` |
262
+ | [Jira Story Facilitator](https://chat-preview.lobehub.com/market?agent=jira-product-manager)<br/><sup>By **[emad-pg](https://github.com/emad-pg)** on **2024-02-19**</sup> | Specialized in transforming feature ideas into comprehensive Jira stories<br/>`technical-product-management` `story-creation` `jira` |
263
+ | [ThinkTank360](https://chat-preview.lobehub.com/market?agent=think-tank-business-strategy)<br/><sup>By **[mikelix](https://github.com/mikelix)** on **2024-02-19**</sup> | Skilled consultant channeling wisdom of Steve Jobs, Elon Musk, MA Yun, Plato, and Ray Dalio for decision reviews, judgements, and advice.<br/>`innovation` `wisdom` `think-tank` `business-strategy` |
235
264
 
236
265
  > 📊 Total agents: [<kbd>**181**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
237
266
 
@@ -243,9 +272,9 @@ Our marketplace is not just a showcase platform but also a collaborative space.
243
272
 
244
273
  </div>
245
274
 
246
- ![](https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp)
275
+ [![][image-feat-pwa]][docs-feat-pwa]
247
276
 
248
- #### `6` Progressive Web App
277
+ ### `8` [Progressive Web App (PWA)][docs-feat-pwa]
249
278
 
250
279
  We deeply understand the importance of providing a seamless experience for users in today's multi-device environment.
251
280
  Therefore, we have adopted Progressive Web Application ([PWA](https://support.google.com/chrome/answer/9658361)) technology,
@@ -270,9 +299,9 @@ providing smooth animations, responsive layouts, and adapting to different devic
270
299
 
271
300
  </div>
272
301
 
273
- ![](https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp)
302
+ [![][image-feat-mobile]][docs-feat-mobile]
274
303
 
275
- #### `7` Mobile Device Adaptation
304
+ ### `9` [Mobile Device Adaptation][docs-feat-mobile]
276
305
 
277
306
  We have carried out a series of optimization designs for mobile devices to enhance the user's mobile experience. Currently, we are iterating on the mobile user experience to achieve smoother and more intuitive interactions. If you have any suggestions or ideas, we welcome you to provide feedback through GitHub Issues or Pull Requests.
278
307
 
@@ -282,9 +311,9 @@ We have carried out a series of optimization designs for mobile devices to enhan
282
311
 
283
312
  </div>
284
313
 
285
- ![](https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp)
314
+ [![][image-feat-theme]][docs-feat-theme]
286
315
 
287
- #### `8` Theme Mode Selection
316
+ ### `10` [Custom Themes][docs-feat-theme]
288
317
 
289
318
  As a design-engineering-oriented application, LobeChat places great emphasis on users' personalized experiences,
290
319
  hence introducing flexible and diverse theme modes, including a light mode for daytime and a dark mode for nighttime.
@@ -302,7 +331,7 @@ Whether it's a desire for a sober dark blue, a lively peach pink, or a professio
302
331
 
303
332
  </div>
304
333
 
305
- #### What's more
334
+ ### `*` What's more
306
335
 
307
336
  Beside these features, LobeChat also have much better basic technique underground:
308
337
 
@@ -330,7 +359,7 @@ Beside these features, LobeChat also have much better basic technique undergroun
330
359
 
331
360
  > \[!NOTE]
332
361
  >
333
- > The complete list of reports can be found in the [📘 Lighthouse Reports](https://github.com/lobehub/lobe-chat/wiki/Lighthouse)
362
+ > The complete list of reports can be found in the [📘 Lighthouse Reports][docs-lighthouse]
334
363
 
335
364
  | Desktop | Mobile |
336
365
  | :-----------------------------------------: | :----------------------------------------: |
@@ -347,6 +376,10 @@ Beside these features, LobeChat also have much better basic technique undergroun
347
376
 
348
377
  LobeChat provides Self-Hosted Version with Vercel and [Docker Image][docker-release-link]. This allows you to deploy your own chatbot within a few minutes without any prior knowledge.
349
378
 
379
+ > \[!TIP]
380
+ >
381
+ > Learn more about [📘 Build your own LobeChat][docs-self-hosting] by checking it out.
382
+
350
383
  ### `A` Deploying with Vercel, Zeabur or Sealos
351
384
 
352
385
  If you want to deploy this service yourself on either Vercel or Zeabur, you can follow these steps:
@@ -370,7 +403,7 @@ If you have deployed your own project following the one-click deployment steps i
370
403
 
371
404
  > \[!TIP]
372
405
  >
373
- > We suggest you redeploy using the following steps, [📘 Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync).
406
+ > We suggest you redeploy using the following steps, [📘 Auto Sync With Latest][docs-upstream-sync]
374
407
 
375
408
  <br/>
376
409
 
@@ -405,7 +438,7 @@ $ docker run -d -p 3210:3210 \
405
438
 
406
439
  > \[!NOTE]
407
440
  >
408
- > For detailed instructions on deploying with Docker, please refer to the [📘 Docker Deployment Guide](https://github.com/lobehub/lobe-chat/wiki/Docker-Deployment)
441
+ > For detailed instructions on deploying with Docker, please refer to the [📘 Docker Deployment Guide][docs-docker]
409
442
 
410
443
  <br/>
411
444
 
@@ -422,7 +455,7 @@ This project provides some additional configuration items set with environment v
422
455
 
423
456
  > \[!NOTE]
424
457
  >
425
- > The complete list of environment variables can be found in the [📘 Environment Variables](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable)
458
+ > The complete list of environment variables can be found in the [📘 Environment Variables][docs-env-var]
426
459
 
427
460
  <div align="right">
428
461
 
@@ -432,12 +465,12 @@ This project provides some additional configuration items set with environment v
432
465
 
433
466
  ## 📦 Ecosystem
434
467
 
435
- | NPM | Repository | Description | Version |
436
- | ------------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
437
- | [@lobehub/ui][lobe-ui-link] | [lobehub/lobe-ui][lobe-ui-github] | Lobe UI is an open-source UI component library dedicated to building AIGC web applications. | [![][lobe-ui-shield]][lobe-ui-link] |
438
- | [@lobehub/tts][lobe-tts-link] | [lobehub/lobe-tts][lobe-tts-github] | Lobe TTS is a high-quality & reliable TTS/STT React Hooks library | [![][lobe-tts-shield]][lobe-tts-link] |
439
- | [@lobehub/lint][lobe-lint-link] | [lobehub/lobe-lint][lobe-lint-github] | LobeLint provides configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub. | [![][lobe-lint-shield]][lobe-lint-link] |
440
- | @lobehub/assets | [lobehub/assets][lobe-assets-github] | Logo assets, favicons, webfonts for LobeHub. | |
468
+ | NPM | Repository | Description | Version |
469
+ | --------------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------- |
470
+ | [@lobehub/ui][lobe-ui-link] | [lobehub/lobe-ui][lobe-ui-github] | Open-source UI component library dedicated to building AIGC web applications. | [![][lobe-ui-shield]][lobe-ui-link] |
471
+ | [@lobehub/icons][lobe-icons-link] | [lobehub/lobe-icons][lobe-icons-github] | Popular AI / LLM Model Brand SVG Logo and Icon Collection. | [![][lobe-icons-shield]][lobe-icons-link] |
472
+ | [@lobehub/tts][lobe-tts-link] | [lobehub/lobe-tts][lobe-tts-github] | High-quality & reliable TTS/STT React Hooks library | [![][lobe-tts-shield]][lobe-tts-link] |
473
+ | [@lobehub/lint][lobe-lint-link] | [lobehub/lobe-lint][lobe-lint-github] | Configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub. | [![][lobe-lint-shield]][lobe-lint-link] |
441
474
 
442
475
  <div align="right">
443
476
 
@@ -447,7 +480,7 @@ This project provides some additional configuration items set with environment v
447
480
 
448
481
  ## 🧩 Plugins
449
482
 
450
- Plugins provide a means to extend the [Function Calling][fc-link] capabilities of LobeChat. They can be used to introduce new function calls and even new ways to render message results. If you are interested in plugin development, please refer to our [📘 Plugin Development Guide](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development) in the Wiki.
483
+ Plugins provide a means to extend the [Function Calling][docs-functionc-call] capabilities of LobeChat. They can be used to introduce new function calls and even new ways to render message results. If you are interested in plugin development, please refer to our [📘 Plugin Development Guide][docs-plugin-dev] in the Wiki.
451
484
 
452
485
  - [lobe-chat-plugins][lobe-chat-plugins]: This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for LobeChat to the user.
453
486
  - [chat-plugin-template][chat-plugin-template]: This is the plugin template for LobeChat plugin development.
@@ -460,7 +493,7 @@ Plugins provide a means to extend the [Function Calling][fc-link] capabilities o
460
493
  >
461
494
  > - [x] [**Plugin Phase 1**](https://github.com/lobehub/lobe-chat/issues/73): Implement separation of the plugin from the main body, split the plugin into an independent repository for maintenance, and realize dynamic loading of the plugin.
462
495
  > - [x] [**Plugin Phase 2**](https://github.com/lobehub/lobe-chat/issues/97): The security and stability of the plugin's use, more accurately presenting abnormal states, the maintainability of the plugin architecture, and developer-friendly.
463
- > - [ ] [**Plugin Phase 3**](https://github.com/lobehub/lobe-chat/issues/149): Higher-level and more comprehensive customization capabilities, support for plugin authentication, and examples.
496
+ > - [x] [**Plugin Phase 3**](https://github.com/lobehub/lobe-chat/issues/149): Higher-level and more comprehensive customization capabilities, support for plugin authentication, and examples.
464
497
 
465
498
  <div align="right">
466
499
 
@@ -483,7 +516,7 @@ $ pnpm install
483
516
  $ pnpm dev
484
517
  ```
485
518
 
486
- If you would like to learn more details, please feel free to look at our [📘 Development Guide](https://github.com/lobehub/lobe-chat/wiki/index)
519
+ If you would like to learn more details, please feel free to look at our [📘 Development Guide][docs-dev-guide].
487
520
 
488
521
  <div align="right">
489
522
 
@@ -545,7 +578,7 @@ Contributions of all types are more than welcome; if you are interested in contr
545
578
 
546
579
  </div>
547
580
 
548
- ## 🩷 Sponsor
581
+ ## ❤️ Sponsor
549
582
 
550
583
  Every bit counts and your one-time donation sparkles in our galaxy of support! You're a shooting star, making a swift and bright impact on our journey. Thank you for believing in us – your generosity guides us toward our mission, one brilliant flash at a time.
551
584
 
@@ -564,7 +597,8 @@ Every bit counts and your one-time donation sparkles in our galaxy of support! Y
564
597
 
565
598
  ## 🔗 More Products
566
599
 
567
- - **[🤯 Lobe Theme][lobe-theme]:** The modern theme for Stable Diffusion WebUI, exquisite interface design, highly customizable UI, and efficiency-boosting features.
600
+ - **[🅰️ Lobe SD Theme][lobe-theme]:** Modern theme for Stable Diffusion WebUI, exquisite interface design, highly customizable UI, and efficiency-boosting features.
601
+ - **[⛵️ Lobe Midjourney WebUI][lobe-midjourney-webui]:** WebUI for Midjourney, leverages AI to quickly generate a wide array of rich and diverse images from text prompts, sparking creativity and enhancing conversations.
568
602
  - **[🌏 Lobe i18n][lobe-i18n] :** Lobe i18n is an automation tool for the i18n (internationalization) translation process, powered by ChatGPT. It supports features such as automatic splitting of large files, incremental updates, and customization options for the OpenAI model, API proxy, and temperature.
569
603
  - **[💌 Lobe Commit][lobe-commit]:** Lobe Commit is a CLI tool that leverages Langchain/ChatGPT to generate Gitmoji-based commit messages.
570
604
 
@@ -614,7 +648,27 @@ This project is [MIT](./LICENSE) licensed.
614
648
  [docker-release-shield]: https://img.shields.io/docker/v/lobehub/lobe-chat?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square
615
649
  [docker-size-link]: https://hub.docker.com/r/lobehub/lobe-chat
616
650
  [docker-size-shield]: https://img.shields.io/docker/image-size/lobehub/lobe-chat?color=369eff&labelColor=black&style=flat-square
617
- [fc-link]: https://sspai.com/post/81986
651
+ [docs]: https://chat-docs.lobehub.com/en
652
+ [docs-dev-guide]: https://github.com/lobehub/lobe-chat/wiki/index
653
+ [docs-docker]: https://chat-docs.lobehub.com/en/self-hosting/platform/docker
654
+ [docs-env-var]: https://chat-docs.lobehub.com/en/self-hosting/environment-variables
655
+ [docs-feat-agent]: https://chat-docs.lobehub.com/en/usage/features/agent-market
656
+ [docs-feat-local]: https://chat-docs.lobehub.com/en/usage/features/local-llm
657
+ [docs-feat-mobile]: https://chat-docs.lobehub.com/en/usage/features/mobile
658
+ [docs-feat-plugin]: https://chat-docs.lobehub.com/en/usage/features/plugin-system
659
+ [docs-feat-provider]: https://chat-docs.lobehub.com/en/usage/features/multi-ai-providers
660
+ [docs-feat-pwa]: https://chat-docs.lobehub.com/en/usage/features/pwa
661
+ [docs-feat-t2i]: https://chat-docs.lobehub.com/en/usage/features/text-to-image
662
+ [docs-feat-theme]: https://chat-docs.lobehub.com/en/usage/features/theme
663
+ [docs-feat-tts]: https://chat-docs.lobehub.com/en/usage/features/tts
664
+ [docs-feat-vision]: https://chat-docs.lobehub.com/en/usage/features/vision
665
+ [docs-functionc-call]: https://platform.openai.com/docs/guides/function-calling
666
+ [docs-lighthouse]: https://github.com/lobehub/lobe-chat/wiki/Lighthouse
667
+ [docs-plugin-dev]: https://chat-docs.lobehub.com/en/usage/plugins/development
668
+ [docs-self-hosting]: https://chat-docs.lobehub.com/en/self-hosting/start
669
+ [docs-upstream-sync]: https://chat-docs.lobehub.com/en/self-hosting/advanced/upstream-sync
670
+ [docs-usage-ollama]: https://chat-docs.lobehub.com/en/usage/providers/ollama
671
+ [docs-usage-plugin]: https://chat-docs.lobehub.com/en/usage/plugins/basic
618
672
  [fossa-license-link]: https://app.fossa.com/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat
619
673
  [fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat.svg?type=large
620
674
  [github-action-release-link]: https://github.com/actions/workflows/lobehub/lobe-chat/release.yml
@@ -623,7 +677,6 @@ This project is [MIT](./LICENSE) licensed.
623
677
  [github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-chat/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
624
678
  [github-contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
625
679
  [github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-chat?color=c4f042&labelColor=black&style=flat-square
626
- [github-document-link]: https://chat-docs.lobehub.com/en
627
680
  [github-forks-link]: https://github.com/lobehub/lobe-chat/network/members
628
681
  [github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-chat?color=8ae8ff&labelColor=black&style=flat-square
629
682
  [github-issues-link]: https://github.com/lobehub/lobe-chat/issues
@@ -639,14 +692,30 @@ This project is [MIT](./LICENSE) licensed.
639
692
  [github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-chat?color=ffcb47&labelColor=black&style=flat-square
640
693
  [github-trending-shield]: https://trendshift.io/api/badge/repositories/2256
641
694
  [github-trending-url]: https://trendshift.io/repositories/2256
695
+ [image-banner]: https://github.com/lobehub/lobe-chat/assets/28616219/9f155dff-4737-429f-9cad-a70a1a860c5f
696
+ [image-feat-agent]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670869-f1ffbf66-42b6-42cf-a937-9ce1f8328514.png
697
+ [image-feat-local]: https://github.com/lobehub/lobe-chat/assets/28616219/ca9a21bc-ea6c-4c90-bf4a-fa53b4fb2b5c
698
+ [image-feat-mobile]: https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp
699
+ [image-feat-plugin]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670883-33c43a5c-a512-467e-855c-fa299548cce5.png
700
+ [image-feat-privoder]: https://github.com/lobehub/lobe-chat/assets/28616219/b164bc54-8ba2-4c1e-b2f2-f4d7f7e7a551
701
+ [image-feat-pwa]: https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp
702
+ [image-feat-t2i]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/297746445-0ff762b9-aa08-4337-afb7-12f932b6efbb.png
703
+ [image-feat-theme]: https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp
704
+ [image-feat-tts]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072124-c9853d8d-f1b5-44a8-a305-45ebc0f6d19a.png
705
+ [image-feat-vision]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072129-382bdf30-e3d6-4411-b5a0-249710b8ba08.png
706
+ [image-overview]: https://github.com/lobehub/lobe-chat/assets/28616219/8b04c3c9-3d71-4fb4-bd9b-a4f415c5876d
707
+ [image-star]: https://github.com/lobehub/lobe-chat/assets/17870709/cb06b748-513f-47c2-8740-d876858d7855
642
708
  [issues-link]: https://img.shields.io/github/issues/lobehub/lobe-chat.svg?style=flat
643
- [lobe-assets-github]: https://github.com/lobehub/lobe-assets
644
709
  [lobe-chat-plugins]: https://github.com/lobehub/lobe-chat-plugins
645
710
  [lobe-commit]: https://github.com/lobehub/lobe-commit/tree/master/packages/lobe-commit
646
711
  [lobe-i18n]: https://github.com/lobehub/lobe-commit/tree/master/packages/lobe-i18n
712
+ [lobe-icons-github]: https://github.com/lobehub/lobe-icons
713
+ [lobe-icons-link]: https://www.npmjs.com/package/@lobehub/icons
714
+ [lobe-icons-shield]: https://img.shields.io/npm/v/@lobehub/icons?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
647
715
  [lobe-lint-github]: https://github.com/lobehub/lobe-lint
648
716
  [lobe-lint-link]: https://www.npmjs.com/package/@lobehub/lint
649
717
  [lobe-lint-shield]: https://img.shields.io/npm/v/@lobehub/lint?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
718
+ [lobe-midjourney-webui]: https://github.com/lobehub/lobe-midjourney-webui
650
719
  [lobe-theme]: https://github.com/lobehub/sd-webui-lobe-theme
651
720
  [lobe-tts-github]: https://github.com/lobehub/lobe-tts
652
721
  [lobe-tts-link]: https://www.npmjs.com/package/@lobehub/tts
@@ -671,7 +740,7 @@ This project is [MIT](./LICENSE) licensed.
671
740
  [share-whatsapp-shield]: https://img.shields.io/badge/-share%20on%20whatsapp-black?labelColor=black&logo=whatsapp&logoColor=white&style=flat-square
672
741
  [share-x-link]: https://x.com/intent/tweet?hashtags=chatbot%2CchatGPT%2CopenAI&text=Check%20this%20GitHub%20repository%20out%20%F0%9F%A4%AF%20LobeChat%20-%20An%20open-source%2C%20extensible%20%28Function%20Calling%29%2C%20high-performance%20chatbot%20framework.%20It%20supports%20one-click%20free%20deployment%20of%20your%20private%20ChatGPT%2FLLM%20web%20application.&url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat
673
742
  [share-x-shield]: https://img.shields.io/badge/-share%20on%20x-black?labelColor=black&logo=x&logoColor=white&style=flat-square
674
- [sponsor-link]: https://opencollective.com/lobehub 'Become 🩷 LobeHub Sponsor'
743
+ [sponsor-link]: https://opencollective.com/lobehub 'Become ❤️ LobeHub Sponsor'
675
744
  [sponsor-shield]: https://img.shields.io/badge/-Sponsor%20LobeHub-f04f88?logo=opencollective&logoColor=white&style=flat-square
676
745
  [submit-agents-link]: https://github.com/lobehub/lobe-chat-agents
677
746
  [submit-agents-shield]: https://img.shields.io/badge/🤖/🏪_submit_agent-%E2%86%92-c4f042?labelColor=black&style=for-the-badge