Sengi-Windows-MacOS-Linux/README.md

71 lines
2.9 KiB
Markdown
Raw Normal View History

2019-03-13 06:57:23 +01:00
![GitHub release](https://img.shields.io/github/release/nicolasconstant/sengi.svg?style=flat-square) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=flat-square)](https://www.gnu.org/licenses/agpl-3.0) [![AppVeyor master](https://img.shields.io/appveyor/ci/NicolasConstant/sengi/master.svg?style=flat-square)](https://ci.appveyor.com/project/NicolasConstant/sengi) [![AppVeyor tests master](https://img.shields.io/appveyor/tests/nicolasconstant/sengi/master.svg?style=flat-square)](https://ci.appveyor.com/project/NicolasConstant/sengi/build/tests)
2018-09-21 03:01:21 +02:00
## 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.
2019-08-03 00:27:03 +02:00
It is strongly focused on the following points:
2018-09-21 03:01:21 +02:00
* 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)
2018-09-21 03:01:21 +02:00
2019-08-03 00:27:03 +02:00
It is released as a **browser webapp** and also packaged as an **cross-platform desktop application** (Mac, Windows, and Linux).
## Official project page
[Discover Sengi](https://nicolasconstant.github.io/sengi/)
2018-09-21 03:01:21 +02:00
2018-09-21 03:08:31 +02:00
## State of development
2020-12-18 04:36:46 +01:00
The first major stable release has been published (1.0.0), the project is open to external contributions.
2018-09-21 03:08:31 +02:00
## Screens
2020-08-29 05:57:08 +02:00
![https://raw.githubusercontent.com/NicolasConstant/sengi/master/docs/images/presentation_small.gif](https://raw.githubusercontent.com/NicolasConstant/sengi/master/docs/images/presentation_small.gif)
2018-09-21 03:08:31 +02:00
2020-09-03 01:20:31 +02:00
## Docker
2018-09-21 03:01:21 +02:00
2020-09-03 01:20:31 +02:00
A docker image is available for auto-hosting your own Sengi webapp!
2018-09-21 03:01:21 +02:00
2020-09-03 01:20:31 +02:00
```
docker run -d -p 80:80 nicolasconstant/sengi
```
2018-09-21 03:01:21 +02:00
2020-09-17 02:18:22 +02:00
Find more informations [here](https://github.com/NicolasConstant/sengi/blob/master/DOCKER.md).
2020-09-03 01:20:31 +02:00
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```
2018-09-21 03:01:21 +02:00
2020-09-03 01:20:31 +02:00
## Contact
* [Official Sengi Account](https://mastodon.social/@sengi_app)
2018-09-21 03:01:21 +02:00
2019-02-21 01:18:21 +01:00
## Contribute
2020-08-29 18:55:22 +02:00
Please see the [contributing guidelines](https://github.com/NicolasConstant/sengi/blob/master/CONTRIBUTING.md)
2018-04-24 20:51:37 +02:00
## License
2020-08-29 18:55:22 +02:00
This project is licensed under the AGPLv3 License - see [LICENSE](https://github.com/NicolasConstant/sengi/blob/master/LICENSE) for details
2018-09-21 03:01:21 +02:00
2019-11-23 22:30:09 +01:00
## Credits
2020-08-29 18:55:22 +02:00
See [credits](https://github.com/NicolasConstant/sengi/blob/master/CREDITS.md)
2019-11-23 22:30:09 +01:00
2018-09-21 03:01:21 +02:00
## Dependencies
2019-03-13 06:55:55 +01:00
* [Angular 7](https://github.com/angular/angular)
2018-09-21 03:01:21 +02:00
* [NGXS](https://github.com/ngxs/store)
* [SASS](https://github.com/sass/dart-sass)
2020-09-18 03:40:54 +02:00
* [Electron 10](https://github.com/electron/electron)
2018-09-21 03:01:21 +02:00
2020-09-03 01:20:31 +02:00
## What's a sengi?!
It's a little [elephant shrew](https://en.wikipedia.org/wiki/Elephant_shrew) from Africa:
![Rhynchocyon petersi](https://upload.wikimedia.org/wikipedia/commons/thumb/8/81/Rhynchocyon_petersi_from_side.jpg/400px-Rhynchocyon_petersi_from_side.jpg)
2018-09-21 03:01:21 +02:00