mirror of
https://github.com/YunoHost-Apps/minchat_ynh.git
synced 2024-09-03 19:36:29 +02:00
58 lines
2.6 KiB
Markdown
58 lines
2.6 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Minchat for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/minchat)  
|
|
|
|
[](https://install-app.yunohost.org/?app=minchat)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Minchat quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
Minchat is a free minimalist chat application. It is based on [wojtek77/chat](https://github.com/wojtek77/chat), itself based on [Gabriel Nava's tutorial](http://code.tutsplus.com/tutorials/how-to-create-a-simple-web-based-chat-application--net-5931).
|
|
|
|
### Features
|
|
|
|
- Simple web chat: only requires a browser ; no XMPP application.
|
|
- No need for users to register. Just need the web address. But optional authorisation control.
|
|
- On connection, the page is fed with the messages of the day
|
|
- Args are in the URL as *get* arguments, so that you can share the URL or make it a favorite to avoid filling a form.
|
|
Example : `https://__DOMAIN____PATH__/minchat/?room=Living&name=John`
|
|
- Optionaly multi room
|
|
|
|
**Shipped version:** 2017.05.30~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## :red_circle: Antifeatures
|
|
|
|
- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc.
|
|
|
|
## Documentation and resources
|
|
|
|
- Upstream app code repository: <https://github.com/wojtek77/chat>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/minchat>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/minchat_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/minchat_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade minchat -u https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|