koel_ynh/README.md

<!--
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.
-->

# Koel for YunoHost

[![Integration level](https://dash.yunohost.org/integration/koel.svg)](https://ci-apps.yunohost.org/ci/apps/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 Koel with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=koel)

*[Read this README in other languages.](./ALL_README.md)*

> *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

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:** 7.0.10~ynh1

**Demo:** <https://demo.koel.dev>

## Screenshots

![Screenshot of Koel](./doc/screenshots/showcase.png)

## Documentation and resources

- Official app website: <https://koel.dev>
- Official admin documentation: <https://docs.koel.dev>
- Upstream app code repository: <https://github.com/koel/koel>
- YunoHost Store: <https://apps.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/koel_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/koel_ynh/tree/testing --debug
or
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>