README.en.md

An instant messaging system built with Tauri, Vite 7, Vue 3, and TypeScript

中文 | English | Deutsch | Español | français | 日本語 | 한국어 | Português | Русский

🌐 Supported Platforms

Platform	Supported Versions
Windows	Windows 10, Windows 11
macOS	macOS 10.5+ Mac26 has supported
Linux	Ubuntu 22.0+
iOS	iOS 9.0+ (iOS26 Real machine is supported. Tauri does not support Intel chips running on ios26 emulators)
Android	Android 12+ (SDK30+)
Web	⚠️Not currently supported (custom removal required)

📝 Project Introduction

HuLa is an instant messaging system built with Tauri, Vite 7, Vue 3, and TypeScript. It leverages Tauri's cross-platform capabilities and Vue 3's reactive design, combined with TypeScript's type safety features and Vite 7's fast build process, providing users with an efficient, secure, and user-friendly communication solution.

🛠️ Tech Stack

• Tauri: Provides a lightweight, high-performance desktop application container for this project, enabling us to develop cross-platform desktop applications using frontend technology stack. Tauri's design philosophy is to minimize resource consumption while ensuring security.
• Vite 7: Vite is a modern frontend build tool that leverages native ES module imports to provide a fast development server, while also offering powerful support for production environment packaging. Vite 7 is its latest version, bringing more optimizations and features.
• Vue 3: Vue 3 is a progressive JavaScript framework for building user interfaces. Its Composition API, better TypeScript integration, and mobile optimization make developing complex single-page applications simpler and more efficient.
• TypeScript: TypeScript is a superset of JavaScript that adds a type system on top of JavaScript. This allows us to catch more errors during development and provides better editor support.

🖼️ Project Preview

✨ Features

🔐 User Authentication System

Feature	Description	Status
🔑	Username/Password Login
📱	QR Code Scan Login
💻	Multi-device Login Management

💬 Message Communication

Feature	Description	Status
👤	One-on-one Private Chat
👥	Group Chat
↩️	Message Recall
📢	@Mention & Reply Features
👁️	Message Read Status
😊	Emoji Features
🖱️	Message Right-click Menu
🔗	Link Preview Cards
👍	Message Like Interaction
📔	Chat History Management

🤝 Social Management

Feature	Description	Status
➕	Add & Remove Friends
🔍	Friend Search
🏢	Group Creation & Management
🟢	Friend Online Status
🎖️	Friend Badge System
🚫	Block & Do Not Disturb
📤	Message Forwarding
📋	Group Announcements
🏷️	Nickname & Remark Management
📍	Get and Send Location
🔥	Scan code to log in and join the group

🎨 User Experience

Feature	Description	Status
🖼️	Modern UI Design
🌙	Dark & Light Theme
🎭	Skin Theme Switching

🛠️ System Features

Feature	Description	Status
🪟	Multi-window Management
🔔	System Tray Notifications
📷	Image Viewer
✂️	Screenshot Feature
🎙️	Voice Calling
🎥	Video Calling
⌨️	Global Shortcut Control
📺	Dedicated Media Viewer
📁	File Upload (Qiniu Cloud)
🔄	Auto-update System
🌍	i18n support

🌐 Cross-platform Support

Feature	Description	Status
💻	Windows/macOS/Linux
📱	iOS/Android Adaptation

🤖 AI Integration

Feature	Description	Status
🧠	AI Chat Assistant
🔌	Multi-platform AI Support

App Upgrade Sponsor

👏 Thanks to all Contributors!

📥 Installation & Running

# Clone the project
git clone https://gitee.com/HulaSpark/HuLa.git
# or
git clone https://github.com/HulaSpark/HuLa.git

# Enter project directory
cd HuLa

# Install dependencies
pnpm install

# Run development server
pnpm run tauri:dev

# Build for production
pnpm run tauri:build

⚠️ Important Notes (macOS Users)

Downloading installation packages from the web may show a damaged package prompt, possibly encountering certificate issues due to macOS security mechanisms. Please follow these steps to resolve:

1. Open "System Settings" - "Security & Privacy", check as shown: Allow apps downloaded from "Anywhere" to run:

2. If errors persist, execute the following commands in Terminal:

## Execute before installation
sudo xattr -rd com.apple.quarantine path/to/your/downloaded/package

## If already installed, execute the following
sudo xattr -r -d com.apple.quarantine /Applications/ApplicationName.app

📋 Commit Guidelines

Execute pnpm run commit to invoke git commit interaction, complete information input and selection according to prompts.

⚖️ Disclaimer

1. This project is provided as an open-source project. Developers do not provide any form of explicit or implicit warranties for the functionality, security, or applicability of the software within the scope permitted by law.
2. Users clearly understand and agree that the risk of using this software is entirely borne by the user. The software is provided on an "as is" and "as available" basis. Developers do not provide any form of warranty, whether explicit or implicit, including but not limited to warranties of merchantability, fitness for a particular purpose, and non-infringement.
3. Under no circumstances shall developers or their suppliers be liable for any direct, indirect, incidental, special, punitive, or consequential damages, including but not limited to profit loss, business interruption, personal information leakage, or other commercial damages or losses arising from the use of this software.
4. All users conducting secondary development on this project must commit to using this software for legal purposes and are responsible for complying with local laws and regulations.
5. Developers have the right to modify the software's functions or features at any time, as well as any part of this disclaimer, and these modifications may be reflected in the form of software updates.

The final interpretation of this disclaimer belongs to the developers

🎁 Support the Project

💝 Sponsor Support

If you find HuLa helpful, welcome to sponsor and support us. Your support is our motivation to keep moving forward!

---

💬 Join Community

🙏 Thanks to Sponsors

💎 Diamond Sponsors (￥1000+)

💝 Date	👤 Sponsor	💰 Amount	🏷️ Platform
2025-09-12	翟可	¥1688

🏆 Gold Sponsors ($15+)

💝 Date	👤 Sponsor	💰 Amount	🏷️ Platform
2025-12-13	M（PiDAOLab）	¥500
2025-11-12	星	¥500
2025-09-03	烛火	¥500
2025-09-05	Orion	¥200
2025-10-24	唐勇（伏威）	¥400
2025-08-26	唐勇	¥200
2025-04-25	上官俊斌	¥200
2025-05-27	临安居士	¥188
2025-04-20	姜兴(Simon)	¥188
2025-02-17	禾硕	¥168
2025-10-16	xx豪	¥101
2025-12-25	三愿	¥100
2025-10-15	兵	¥100
2025-08-13	zhongjing	¥100
2025-07-15	粉兔	¥100
2025-02-8	Boom....	¥100

🥈 Silver Sponsors ($8-14)

💝 Date	👤 Sponsor	💰 Amount	🏷️ Platform
2025-11-29	Sven	¥66
2025-06-26	m udDy🐖	¥88
2025-05-09	犹豫，就会败北。	¥88
2025-04-01	墨	¥88.88
2025-02-8	邓伟	¥88
2025-02-7	dennis	¥40
2025-11-5	匿名用户	¥66
2025-02-6	小二	¥62
2025-05-15	孤鸿影	¥56
2026-01-14	赵赫	¥50
2026-01-05	Dumbness	¥50

🥉 Bronze Sponsors ($3-7)

💝 Date	👤 Sponsor	💰 Amount	🏷️ Platform
2025-08-12	云鹏	¥20
2025-08-12	*持	¥20
2025-06-03	洪流	¥20
2025-05-27	刘启成	¥20
2025-05-20	匿名赞助者	¥20

---

📄 Open Source License

---