mirror of
https://github.com/NicolasConstant/sengi
synced 2024-12-22 21:58:59 +01:00
73 lines
3.1 KiB
Markdown
73 lines
3.1 KiB
Markdown
 [](https://www.gnu.org/licenses/agpl-3.0) [](https://ci.appveyor.com/project/NicolasConstant/sengi) [](https://ci.appveyor.com/project/NicolasConstant/sengi/build/tests)
|
|
|
|
## Introduction
|
|
|
|
Sengi is a **Mastodon** and **Pleroma** desktop focused client. It takes inspiration from the old Tweetdeck [client](https://static.makeuseof.com/wp-content/uploads/2012/02/muo-tweetdeck2b.png), the new Tweetdeck webapp and Mastodon UI.
|
|
|
|
It is strongly focused on the following points:
|
|
|
|
* Heavily oriented on multi-accounts usage
|
|
* Desktop based interactions (right click, left click, etc)
|
|
* One column at a time display (leave it on the side of your screen, and keep an eye on it while doing your other stuff)
|
|
|
|
It is released as a **browser webapp** and also packaged as an **cross-platform desktop application** (Mac, Windows, and Linux).
|
|
|
|
The Electron code isn't hosted here anymore, and you'll find it [here](https://github.com/NicolasConstant/sengi-electron).
|
|
|
|
## Official project page
|
|
|
|
[Discover Sengi](https://nicolasconstant.github.io/sengi/)
|
|
|
|
## State of development
|
|
|
|
The first major stable release has been published (1.0.0), the project is open to external contributions.
|
|
|
|
## Screens
|
|
|
|
|
|
|
|
## Docker
|
|
|
|
A docker image is available for auto-hosting your own Sengi webapp!
|
|
|
|
```
|
|
docker run -d -p 80:80 nicolasconstant/sengi
|
|
```
|
|
|
|
Find more informations [here](https://github.com/NicolasConstant/sengi/blob/master/DOCKER.md).
|
|
|
|
The docker image also provide a landing page so that you can open a pop-up really easily. <br />
|
|
It's available in ```https://your-host/start/index.html```
|
|
|
|
## Contact
|
|
|
|
* [Official Sengi Account](https://mastodon.social/@sengi_app)
|
|
|
|
## Contribute
|
|
|
|
Please see the [contributing guidelines](https://github.com/NicolasConstant/sengi/blob/master/CONTRIBUTING.md)
|
|
|
|
## License
|
|
|
|
This project is licensed under the AGPLv3 License - see [LICENSE](https://github.com/NicolasConstant/sengi/blob/master/LICENSE) for details
|
|
|
|
## Credits
|
|
|
|
See [credits](https://github.com/NicolasConstant/sengi/blob/master/CREDITS.md)
|
|
|
|
## Dependencies
|
|
|
|
* [Angular 7](https://github.com/angular/angular)
|
|
* [NGXS](https://github.com/ngxs/store)
|
|
* [SASS](https://github.com/sass/dart-sass)
|
|
* [Electron 10](https://github.com/electron/electron)
|
|
|
|
## What's a sengi?!
|
|
|
|
It's a little [elephant shrew](https://en.wikipedia.org/wiki/Elephant_shrew) from Africa:
|
|
|
|
|
|
|
|
|
|
|