💬 Siliao — Team Chat System

A full-featured internal team chat system built with React + Express + Socket.IO

一套功能完整的内部团队聊天系统，基于 React + Express + Socket.IO 构建

Quick Start · Features · Contributing

---

Why / 为什么

Internal teams need a simple, self-hosted chat tool that works out of the box — without relying on third-party SaaS or complex infrastructure. Siliao provides private messaging, group channels, file sharing, search, notifications, and admin controls in a single deployable package.

内部团队需要一个开箱即用、可自托管的聊天工具，不依赖第三方 SaaS 或复杂基础设施。Siliao 在一个可部署的包里提供了私聊、群聊、文件共享、搜索、通知和管理员后台。

Features / 特性

• 🔐 Login — Username/password authentication with JWT
• 💬 Direct Messages — One-on-one private chat with real-time sync
• 👥 Group Channels — Create channels, invite members, manage membership
• 📎 File Upload — Share files/images up to 10MB per message
• 🔍 Global Search — Search across all private and group messages
• 🔔 Unread Counts — Persistent per-thread unread badges + notification center
• ↩️ Message Recall — Recall your own messages (syncs to all participants)
• 👑 Admin Console — System overview, user role management, channel deletion
• 📱 Responsive — Works on desktop and mobile browsers
• ⚡ Real-time — Socket.IO powered instant message delivery
• 🎨 Polished UI — Lucide icons, glass morphism, Slack/Linear-inspired layout

Quick Start / 快速开始

# Clone
git clone https://github.com/zhizhishuo/siliao.git
cd siliao

# Install
npm install

# Run (starts both frontend and backend)
npm run dev

After startup, open the URL shown in terminal (default port 5173 for frontend, 3001 for backend API).

启动后，在终端中查看显示的访问地址（前端默认端口 5173，后端 API 默认端口 3001）。

Demo Accounts / 演示账号

All passwords are password123:

Username	Display Name	Role
li.lei	李雷	Admin
han.mei	韩梅梅	Member
wang.wei	王伟	Member

A default channel 全员群 is created automatically.

How It Works / 工作原理

┌─────────────┐     WebSocket      ┌─────────────┐
│  React App  │◄──────────────────►│  Express +   │
│  (Vite)     │     REST API       │  Socket.IO   │
└─────────────┘◄──────────────────►└──────┬───────┘
                                          │
                                   ┌──────┴───────┐
                                   │   SQLite DB   │
                                   │  + File Store │
                                   └──────────────┘

Tech Stack / 技术栈

Layer	Technology
Frontend	React 19, TypeScript, Vite 8, Socket.IO Client, Lucide Icons
Backend	Express 5, Socket.IO 4, Better-SQLite3, JWT, Multer, bcrypt
Storage	SQLite (WAL mode) + local file uploads
Dev Tools	ESLint, Nodemon, Concurrently

Project Structure / 目录结构

frontend/       React Web client (Vite + TypeScript)
backend/        Express API, Socket.IO, SQLite, uploads

Contributing / 贡献

Contributions are welcome! Please read our Contributing Guide and Code of Conduct.

欢迎贡献！请阅读贡献指南和行为准则。

License / 许可证

MIT © 2026 zhizhishuo

---

If this project helps you, give it a ⭐

如果这个项目对你有帮助，请给一个 ⭐