# OurChat

**Repository Path**: skyuoi/OurChat

## Basic Information

- **Project Name**: OurChat
- **Description**: 跨平台即时通讯软件 ，基于flutter和rust开发，设计清晰优雅，功能简洁强大。github仓库：https://github.com/SkyUOI/OurChat
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: main
- **Homepage**: https://ourchat.skyuoi.org/
- **GVP Project**: No

## Statistics

- **Stars**: 15
- **Forks**: 6
- **Created**: 2024-07-29
- **Last Updated**: 2026-01-09

## Categories & Tags

**Categories**: im

**Tags**: Dart, Rust, Flutter, IM, Redis

## README

# OurChat 🚀

[![codecov](https://codecov.io/github/SkyUOI/OurChat/graph/badge.svg?token=U6BWN74URE)](https://codecov.io/github/SkyUOI/OurChat)[![License](https://img.shields.io/github/license/skyuoi/ourchat)](https://github.com/skyuoi/ourchat/blob/main/LICENSE)[![GitHub stars](https://img.shields.io/github/stars/skyuoi/ourchat)](https://github.com/skyuoi/ourchat/stargazers)[![GitHub issues](https://img.shields.io/github/issues/skyuoi/ourchat)](https://github.com/skyuoi/ourchat/issues)[![GitHub pull requests](https://img.shields.io/github/issues-pr/skyuoi/ourchat)](https://github.com/skyuoi/ourchat/pulls)[![GitHub release](https://img.shields.io/github/v/release/skyuoi/ourchat)](https://github.com/skyuoi/ourchat/releases)[![Last Commit](https://img.shields.io/github/last-commit/skyuoi/ourchat)](https://github.com/skyuoi/ourchat/commits)

<!-- markdownlint-disable MD033 -->
<p align="center">
    <img src="./resource/logo.png" alt="OurChat_logo" />
</p>
<!-- markdownlint-enable MD033 -->

## 🌟 项目介绍

OurChat 是一个可以在 Linux，Windows 和 macOS 上运行的聊天软件。它通过 Flutter 技术支持所有平台。

⚠️ 该项目正处在高速开发中，并且有大量的工作要做。但它已经有一些基本功能，并且已经可以进行初步试用，试试看吧！

## 🖼️ 项目预览

<table align="center">
  <tr>
    <td align="center">
      <img src="screenshots/main.png" alt="主界面" width="400" style="border-radius: 12px; box-shadow: 0 4px 8px rgba(0,0,0,0.1); margin: 8px;">
      <br><em>💬 主聊天界面</em>
    </td>
    <td align="center">
      <img src="screenshots/login_page.png" alt="聊天界面" width="400" style="border-radius: 12px; box-shadow: 0 4px 8px rgba(0,0,0,0.1); margin: 8px;">
      <br><em>🗨️ 登录界面</em>
    </td>
  </tr>
  <tr>
    <td align="center">
      <img src="screenshots/welcome_page.png" alt="联系人界面" width="400" style="border-radius: 12px; box-shadow: 0 4px 8px rgba(0,0,0,0.1); margin: 8px;">
      <br><em>😊 欢迎页</em>
    </td>
    <td align="center">
      <img src="screenshots/about_page.png" alt="设置界面" width="400" style="border-radius: 12px; box-shadow: 0 4px 8px rgba(0,0,0,0.1); margin: 8px;">
      <br><em>⚙️ 关于</em>
    </td>
  </tr>
</table>

## 📱 功能亮点

- 💬 实时消息传递
- 👥 群组聊天
- 🔒 端到端加密
- 🌍 跨平台支持
- 🚀 高性能、低延迟
- 🛠️ 可自托管

## 官方服务器

服务器地址: `skyuoi.org:7777`。在你要开发客户端时，你也可以把它当成开发服务器来辅助开发。服务器使用的 docker 镜像版本是`nightly` (会被定时更新，但不是每天).

## 🚀 愿景与目标

提供一个小到可以轻易在树莓派等设备上运行的聊天软件，为您的公司，家人等搭建属于自己的聊天服务器。与此同时，具备成为大到可以容纳数百万用户的高性能服务端的能力。

🔑 **核心理念**:

- ✅ **自由开放**: 自由，开放是我们设计的初衷，您将会体会到比其余聊天软件多得多的自由
- 🔒 **安全可靠**: 端到端加密等安全保障让 OurChat 能够放心地被您使用
- 🛡️ **隐私保护**: 我们绝对保护您的隐私！

## 🚀 快速开始

### ⚠️ 安全提示

要在生产环境中使用还需要做设置数据库密码等一系列改进，具体参考文档。

### 🖥️ 服务端部署

```shell
cd docker
docker compose up -d
```

更多部署方式请参考 [部署文档](https://ourchat.readthedocs.io/zh-cn/latest/docs/deploy/server-deploy.html)

## 🛠️ 从源代码构建

参见 [构建文档](https://ourchat.readthedocs.io/zh-cn/latest/docs/run/build.html)

## 📚 项目文档

请参考 [文档](https://ourchat.readthedocs.io/zh-cn/latest/)，我们将它部署在了 ReadTheDocs

## 🤝 贡献

请见 [贡献指南](https://ourchat.readthedocs.io/zh-cn/latest/docs/development/contributing.html)

## 🌐 社区

- [Matrix](https://matrix.to/#/#skyuoiourchat:matrix.org)

## 📦 支持的平台

| 平台    | 状态                                                                                                     |
| :------ | :------------------------------------------------------------------------------------------------------- |
| Linux   | ![Linux Test](https://img.shields.io/github/actions/workflow/status/skyuoi/ourchat/server_linux.yml)     |
| Windows | ![Windows Test](https://img.shields.io/github/actions/workflow/status/skyuoi/ourchat/server_windows.yml) |
| macOS   | ![Macos Test](https://img.shields.io/github/actions/workflow/status/skyuoi/ourchat/server_macos.yml)     |