https://github.com/Lipraty/satori-desktop

The universal and cross-platform chat application based on the Satori protocol.
https://github.com/Lipraty/satori-desktop

koishijs satori-protocol

Last synced: 3 months ago
JSON representation

The universal and cross-platform chat application based on the Satori protocol.

• Host: GitHub
• URL: https://github.com/Lipraty/satori-desktop
• Owner: Lipraty
• License: agpl-3.0
• Created: 2024-04-08T15:48:18.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-21T09:33:26.000Z (3 months ago)
• Last Synced: 2024-09-22T18:02:33.105Z (3 months ago)
• Topics: koishijs, satori-protocol
• Language: TypeScript
• Homepage:
• Size: 5.66 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Satori App for Desktop](./sad-logo.png)](https://github.com/Lipraty/satori-desktop)

# Satori App Desktop

The universal and cross-platform chat application based on the Satori protocol.

English | [简体中文](./README_CN.md)



> [!NOTE]

> This is project under development and not ready for production use. Welcome to contribute to this project.

Roadmap

## Roadmap

### Desktop App

- Roadmap: [click here](https://github.com/users/Lipraty/projects/1)

- Todo list: [click here](https://github.com/users/Lipraty/projects/2)

### Satori App Server(SAS)

- Roadmap: TODO

- Todo list: TODO

- Documentation: TODO

### UI Design

- [JSDesign](https://js.design/f/YcrbVO?p=jl2EY3zpvG&mode=design)

## Technologies

- [Cordis](https://github.com/cordiverse/cordis): Meta-Framework for Modern Applications.

- [Satori](https://github.com/satorijs/satori): THe universal messager protocol.

- [Electron](https://www.electronjs.org/): Open-source framework developed and maintained by GitHub.

- [React](https://reactjs.org/): A JavaScript library for building user interfaces.

  - [Foxact](https://foxact.skk.moe/): React component library that is React Hooks/Utils done right.

  - [Zustand](https://zustand-demo.pmnd.rs/): A small, fast and scaleable bearbones state-management solution.

  - [SWR](https://swr.vercel.app/): React Hooks library for data fetching.

- [Shikitor](https://github.com/NWYLZW/shikitor): A simple and lightweight code editor for the web based on shiki.

## Getting Started

Download the latest release from the [releases page]().

## Features

### Cross chat platforms

The project is developed based on the Satori protocol. Benefit from to the excellent design and powerful platform support of the Satori protocol, Satori App Desktop can access multiple chat platforms:

- [x] DingTalk

- [x] Discord

- [x] KOOK

- [x] Lark

- [x] Line

- [x] Mail

- [x] Matrix

- [x] QQ Guild

- [x] Slack

- [x] Telegram

- [x] WhatsApp

- [x] WeCom (WeChat Work)

- [x] WeChat Official

- [x] Zulip

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

[![contributors](https://contrib.rocks/image?repo=Lipraty/satori-desktop)](https://github.com/Lipraty/satori-desktop/graphs/contributors)

## License

This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details.