Skip to content
/ OurChat Public

A cross-platform instant messaging app, made in flutter and rust, supporting matrix

License

Notifications You must be signed in to change notification settings

SkyUOI/OurChat

Repository files navigation

OurChat 🚀

codecovLicenseGitHub starsGitHub issuesGitHub pull requestsGitHub releaseLast Commit

OurChat_logo

🌟 Introduction

OurChat is a chat application for Linux, Windows 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. It cannot be used directly by now.

In the past year of 2024, we have achieved many outstanding tasks, and it is delightful that developers have devoted so much passion to this project in their spare time. Every developer deserves gratitude. 💖

📱 Feature Highlights

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

🚀 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

cd docker
docker compose up -d

For More deployment methods, please refer to deployment document

🛠️ Build from source

Refer to Build Document

📚 Documentation

Refer to Documentation, we deploy it to ReadTheDocs

🤝 Contribution

Please see CONTRIBUTING

🌐 Community

📦 Supported Platforms

Platform Status
Linux Linux Test
Windows Windows Test
Macos Macos Test