๐๐ป Getting Started & Join Our Community
Please be aware that LobeChat is currently under active development, and feedback is welcome for any issues encountered.
No installation or registration necessary! Visit our website to experience it firsthand.
Join our Discord community! This is where you can connect with developers and other enthusiastic users of LobeHub.
Important Star Us, You will receive all release notifications from GitHub without any delay ~ โญ๏ธ
Star History
โจ Features
- ๐จ Quick Deployment: Using the Vercel platform, you can deploy with just one click and complete the process within 1 minute without any complex configuration.
- ๐ Exquisite UI Design: With a carefully designed interface, it offers an elegant appearance and smooth interaction. It supports light and dark themes and is mobile-friendly. PWA support provides a more native-like experience.
- ๐ฃ๏ธ Smooth Conversation Experience: Fluid responses ensure a smooth conversation experience. It fully supports Markdown rendering, including code highlighting, LaTex formulas, Mermaid flowcharts, and more.
- ๐งฉ Plugin Support & Custom Plugin Development: Conversations are extendable with plugins. Users can install and use various plugins, such as search engines, web extraction, etc. It also supports the development of custom plugins to meet custom needs.
- ๐ Privacy Protection: All data is stored locally in the userโs browser, ensuring user privacy.
- ๐ค Customizable Agent Roles: Users can create, share, and debug personalized dialogue agent roles according to their needs, providing more flexible and customized dialogue functions.
- ๐ Custom Domain: If users have their own domain, they can bind it to the platform for quick access to the dialogue agent from anywhere.
- ๐ฌ Role Market: A Role Market is provided where users can select their preferred dialogue agent roles, enriching the content and style of the dialogue.
Note You can find our upcoming Roadmap plans in the Projects section.
๐ธ Snapshot
1 Function Calling Plugin System
By establishing a versatile plugin system, ChatGPT becomes capable of delivering real-time news updates and enhancing your ability to interact with documents and e-commerce data more effectively. This extended functionality positions ChatGPT as a valuable resource across diverse domains. If you have an interest in creating plugins, we offer comprehensive component development documentation, software development kits (SDKs), and pre-made templates in the ๐งฉ Plugin System section below. Join us in our collective efforts to empower ChatGPT, making it both more potent and user-friendly.
2 Prompt Agent Market
In our agent market. We have accumulated a large number of practical, prompt agents that have been used in daily work and study. You can also share your agents here and iterate and optimize your prompt agents with more people. You can submit your agents through ๐ค/๐ช Submit Agents, and our automated i18n workflow will automatically translate your agents into multiple languages, allowing users worldwide to enjoy your wisdom.
Recent SubmitsDescriptionLobeChat Technical Documentation ExpertBy arvinxx on 2023-11-05LobeChat is an AI conversation application built with the Next.js framework. I will help you write the development documentation for LobeChat.development-documentation technical-introduction next-js react lobe-chatSketch Feature Summary ExpertBy arvinxx on 2023-11-02Skilled at extracting key changes from Sketch release notesexperience-design sketch update feature text-summaryMaster of DebatingBy cake79 on 2023-10-26Simulates people who enjoy debating and can express counterarguments to any user inputwriting dialogueGraph GeneratorBy choldrim on 2023-10-23Automatic Graph Generatorgraph
๐ Total agents: 38
3 Progress Web App
Utilize the Progressive Web Application (PWA) technology to achieve a seamless LobeChat experience on your computer or mobile device.
Note If you are unfamiliar with the installation process of PWA, you can add LobeChat as your desktop application (also applicable to mobile devices) by following these steps:
- Launch the Chrome or Edge browser on your computer.
- Visit the LobeChat webpage.
- In the upper right corner of the address bar, click on the Install icon.
- Follow the instructions on the screen to complete the PWA Installation.
4 Theme Mode Selection
LobeChat offers two unique theme modes โ Light Mode and Dark Mode, as well as rich color customization options to meet your personalized needs. By default, our themes will intelligently switch based on your system settings, but if you prefer manual control, you can easily switch in the settings.
5 Mobile Device Adaptation
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.
๐ง Additional snapshots and demonstrations are being progressively addedโฆ
โก๏ธ Performance
Note The complete list of reports can be found in the ๐ Lighthouse Reports
DesktopMobile
๐ Lighthouse Report๐ Lighthouse Report
๐ณ Self Hosting
LobeChat provides Self-Hosted Version with Vercel and Docker Image. This allows you to deploy your own chatbot within a few minutes without any prior knowledge.
A Deploying with Vercel
If you want to deploy this service yourself on Vercel, you can follow these steps:
- Prepare your OpenAI API Key.
- Click the button below to start deployment: Deploy with Vercel. Log in directly with your GitHub account, and remember to fill in the
OPENAI_API_KEY(required) andACCESS_CODE(recommended) on the environment variable section. - After deployment, you can start using it.
- Bind a custom domain (optional): The DNS of the domain assigned by Vercel is polluted in some areas; binding a custom domain can connect directly.
Keep Updated
If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating โupdates available.โ This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to detect updates accurately.
Important We suggest you redeploy using the following steps, ๐ Maintaining Updates with LobeChat Self-Deployment.
B Deploying with Docker
We provide a Docker image for deploying the LobeChat service on your own private device. Use the following command to start the LobeChat service:
$ docker run -d -p 3210:3210 \ -e OPENAI_API_KEY=sk-xxxx \ -e ACCESS_CODE=lobe66 \ lobehub/lobe-chat
Note If you need to use the OpenAI service through a proxy, you can configure the proxy address using the OPENAI_PROXY_URL environment variable:
$ docker run -d -p 3210:3210 \ -e OPENAI_API_KEY=sk-xxxx \ -e OPENAI_PROXY_URL=https://api-proxy.com/v1 \ -e ACCESS_CODE=lobe66 \ lobehub/lobe-chat
Note For detailed instructions on deploying with Docker, please refer to the ๐ Docker Deployment Guide
Environment Variable
This project provides some additional configuration items set with environment variables:
Environment VariableRequiredDescriptionExampleOPENAI_API_KEYYesThis is the API key you apply on the OpenAI account pagesk-xxxxxx...xxxxxxOPENAI_PROXY_URLNoIf you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URLhttps://api.chatanywhere.cn/v1The default value ishttps://api.openai.com/v1ACCESS_CODENoAdd a password to access this service; the password should be a 6-digit number or letterawCT74 or e3@09!
Note The complete list of environment variables can be found in the ๐ Environment Variables
๐ฆ Ecosystem
NPMRepositoryDescriptionVersion@lobehub/uilobehub/lobe-uiLobe UI is an open-source UI component library dedicated to building AIGC web applications.@lobehub/lintlobehub/lobe-lintLobeLint provides configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub.
@lobehub/assetslobehub/assetsLogo assets, favicons, webfonts for LobeHub.
