OurChat 🚀

中文

🌟 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

🖼️ Project Preview

📱 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

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

• Matrix

📦 Supported Platforms

Platform	Status
Linux
Windows
Macos