Skip to content

SkyUOI/OurChat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

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. But it has some basic functionalities and is ready for initial use, have a try!

๐Ÿ–ผ๏ธ Project Preview

ไธป็•Œ้ข
๐Ÿ’ฌ Chat
่Šๅคฉ็•Œ้ข
๐Ÿ—จ๏ธ Login
่”็ณปไบบ็•Œ้ข
๐Ÿ˜Š Welcome
่ฎพ็ฝฎ็•Œ้ข
โš™๏ธ About

๐Ÿ“ฑ 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

๐Ÿ“ฆ Supported Platforms

Platform Status
Linux Linux Test
Windows Windows Test
Macos Macos Test

About

A cross-platform instant messaging app, made in flutter and rust, supporting matrix. Gracefully designed, Powerfully featured

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5