# OurChat

**Repository Path**: liwh_rust/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**: 0
- **Forks**: 8
- **Created**: 2026-07-09
- **Last Updated**: 2026-07-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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 -->

## [中文](./README-zh.md)

## 🌟 Introduction

OurChat is a chat application for Linux, Windows, Web and macOS. It supports all platforms through Flutter.

⚠️ The project is under rapid development, and there is also a lot of work to be done. But it has some basic functionalities and is ready for initial use, have a try!

## Try the Web Client

Try OurChat on the **[Official Web Client](https://ocapp.skyuoi.org/)**

## 🖼️ Project Preview

<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>💬 Chat </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>🗨️ Login </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>😊 Welcome</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>⚙️ About</em>
    </td>
  </tr>
</table>

## 📱 Feature Highlights

- 💬 Real-time messaging
- 👥 Group chats
- 🔒 End-to-end encryption
- 🌍 Cross-platform support
- 🚀 High performance, low latency
- 🛠️ Self-hostable

## Official Server

Server Address: `skyuoi.org:7777`. If you want to develop the client, you can also use it as your development server to work with. The docker image version it uses is `nightly` (It will be updated regularly but not nightly).

## 🚀 Vision & Plan

Provides a lightweight chat software that can easily run on devices like Raspberry Pi, allowing you to set up your own
chat server for your company, family, etc. At the same time, it has the potential to scale up to a high-performance
server capable of accommodating millions of users.

🔑 **Core Principles**:

- ✅ **Freedom & Openness**: Freedom and openness are the principles of our design, and you will experience much more freedom than other chat software
- 🔒 **Security**: End-to-end encryption and other security guarantees make OurChat a service you can trust
- 🛡️ **Privacy**: We absolutely protect your privacy!

## 🚀 Quick Start

### ⚠️ Security Notice

If you want to use it in the product environment, you should do a series of improvements, such as changing
the password of database. More information please refer to document.

### 🖥️ Server Deployment

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

For More deployment methods, please refer
to [deployment document](https://ourchat.readthedocs.io/en/latest/docs/deploy/server-deploy.html)

## 🛠️ Build from source

Refer to [Build Document](https://ourchat.readthedocs.io/en/latest/docs/run/build.html)

## 📚 Documentation

Refer to [Documentation](https://ourchat.readthedocs.io/en/latest/), we deploy it to ReadTheDocs

## 🤝 Contribution

Please see [CONTRIBUTING](https://ourchat.readthedocs.io/en/latest/docs/development/contributing.html)

## 🌐 Community

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

## 📦 Supported Platforms

| Platform | Status                                                                                                   |
| :------- | :------------------------------------------------------------------------------------------------------- |
| 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)     |