README.md
May 23, 2025 ยท View on GitHub
Welcome to Evo Chat ๐
Evo Chat (Evolution Chat) is a modern open-source AI conversation platform dedicated to creating the most elegant interface for large model interactions. It supports integration with mainstream Large Language Model (LLM) providers such as ChatGPT, Deepseak, and more, while continuously evolving with enhanced capabilities like knowledge base augmentation, multimodal processing, and MCP (Model Control Protocol). Supporting cross-platform deployment (Web, App, Windows, Mac, Linux), it provides ubiquitous AI accessibility for users.
๐ผ๏ธ Interface Display
-
Homepage

-
Assistant

-
Knowledge Base

-
MCP

-
MCP Session

-
Model Management

-
Dark Mode

โจ Features
-
๐ฌ Intelligent Conversation
- Support for multiple model integration, providing flexible conversation capabilities
- Context-aware conversations maintaining coherence
- Knowledge base Q&A for quick information retrieval
-
๐ Knowledge Base Management
- Support for creating, editing, and deleting knowledge bases
- Document vectorization for improved retrieval efficiency
- Vector search for quick content location
-
๐ File Management
- Support for file upload, preview, and deletion
- File categorization management
- Batch operations for improved efficiency
-
๐ป Cross-Platform Support
- Web access for anywhere, anytime use
- Desktop client support (Windows, Mac, Linux)
- Mobile app with smooth experience
-
๐ค Intelligent Assistants
- Pre-configured professional domain assistants (programming, writing, translation, etc.)
- Customizable assistant roles and domains
- Independent knowledge base management for assistants
- Quick switching between different assistant scenarios
-
๐ฎ Advanced Features
- MCP (Model Control Protocol) protocol support
๐ Project Structure
.
โโโ packages
โ โโโ b-component # Shared business component library
โ โโโ data-store # Data management
โ โโโ knowledge-service # Knowledge service (electron project only)
โ โโโ pglite-manager # pglite local PostgreSQL database
โ โโโ platform-bridge # Cross-platform capabilities
โ โโโ types # Global type definitions
โ โโโ utils # Common utility functions
โโโ projects
โ โโโ electron-app # Desktop client
โ โโโ h5 # Mobile application
โ โโโ web # Web application
โโโ scripts
โ โโโ build # Build-related scripts
โ โโโ utils # Utility scripts
โโโ docs # Project documentation
๐ฆ Development
Requirements
- Node.js >= 20.18.3
- pnpm >= 9.15.5
Getting Started
# Clone the project
git clone https://github.com/evo-family/evo-chat.git
# Enter project directory
cd evo-chat
# Install dependencies
pnpm install
# Start web
pnpm run dev:web
# Start h5
pnpm run dev:h5
# Start h5
pnpm run dev:h5
# Start electron
pnpm run dev:client
Contact
Add WeChat evo-chat to contact us
๐ฅ Contribution Guide
Welcome to the Evo Chat open source community! We appreciate all contributions, whether it's submitting code, reporting issues, or improving documentation.
How to Contribute
- Fork this repository
- Create your feature branch ( git checkout -b feature/AmazingFeature )
- Commit your changes ( git commit -m 'Add some AmazingFeature' )
- Push to the branch ( git push origin feature/AmazingFeature )
- Submit a Pull Request
Contributors
Thanks to all contributors:
๐ ๅผๆบๅ่ฎฎ
This project is licensed under the Apache 2.0 License.