YunoHost-Apps/koel_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/koel_ynh.git synced 2024-09-03 19:35:54 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2023-09-17 16:19:10 +00:00
parent e4a135b617
commit 7471a87828
2 changed files with 36 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -1,62 +1,52 @@
# Packaging an app, starting from this example
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
* Edit the `manifest.json` with app specific info.
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
* Add a `LICENSE` file for the package.
* Edit `doc/DISCLAIMER*.md`
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!--
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.
-->
# Example app for YunoHost
# Koel for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
[![Integration level](https://dash.yunohost.org/integration/koel.svg)](https://dash.yunohost.org/appci/app/koel) ![Working status](https://ci-apps.yunohost.org/ci/badges/koel.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/koel.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Install Koel with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=koel)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server.
> *This package allows you to install Koel 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
This is a dummy description of this app features
Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side.
Targeting web developers, Koel embraces some of the more modern web technologies to do its job.
**Shipped version:** 1.0~ynh1
**Shipped version:** 6.11.2~ynh1
**Demo:** https://demo.example.com
**Demo:** https://demo.koel.dev
## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg)
![Screenshot of Koel](./doc/screenshots/showcase.png)
## Documentation and resources
* Official app website: <https://example.com>
* Official user documentation: <https://yunohost.org/apps>
* Official admin documentation: <https://yunohost.org/packaging_apps>
* Upstream app code repository: <https://some.forge.com/example/example>
* YunoHost documentation for this app: <https://yunohost.org/app_example>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
* Official app website: <https://koel.dev>
* Official admin documentation: <https://docs.koel.dev>
* Upstream app code repository: <https://github.com/koel/koel>
* YunoHost documentation for this app: <https://yunohost.org/app_koel>
* Report a bug: <https://github.com/YunoHost-Apps/koel_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/koel_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app upgrade koel -u https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

35
README_fr.md
View file

@ -3,49 +3,50 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand.
-->
# Example app pour YunoHost
# Koel pour YunoHost
[![Niveau d’intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
[![Niveau d’intégration](https://dash.yunohost.org/integration/koel.svg)](https://dash.yunohost.org/appci/app/koel) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/koel.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/koel.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Installer Koel avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=koel)
*[Read this readme in english.](./README.md)*
> *Ce package vous permet d’installer Example app rapidement et simplement sur un serveur YunoHost.
> *Ce package vous permet d’installer Koel rapidement et simplement sur un serveur YunoHost.
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
## Vue d’ensemble
Ceci est une fausse description des fonctionalités de l'app
Un simple service web de streaming audio personnel, écrit en Vue pour le client et en Laravel pour le serveur.
Destiné aux développeurs web, Koel utilise certaines des technologies web les plus modernes pour accomplir son travail.
**Version incluse :** 1.0~ynh1
**Version incluse :** 6.11.2~ynh1
**Démo :** https://demo.example.com
**Démo :** https://demo.koel.dev
## Captures d’écran
![Capture d’écran de Example app](./doc/screenshots/example.jpg)
![Capture d’écran de Koel](./doc/screenshots/showcase.png)
## Documentations et ressources
* Site officiel de l’app : <https://example.com>
* Documentation officielle utilisateur : <https://yunohost.org/apps>
* Documentation officielle de l’admin : <https://yunohost.org/packaging_apps>
* Dépôt de code officiel de l’app : <https://some.forge.com/example/example>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
* Site officiel de l’app : <https://koel.dev>
* Documentation officielle de l’admin : <https://docs.koel.dev>
* Dépôt de code officiel de l’app : <https://github.com/koel/koel>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_koel>
* Signaler un bug : <https://github.com/YunoHost-Apps/koel_ynh/issues>
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/koel_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app upgrade koel -u https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
```
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>