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

# Flarum for YunoHost

[![Integration level](https://dash.yunohost.org/integration/flarum.svg)](https://dash.yunohost.org/appci/app/flarum) ![Working status](https://ci-apps.yunohost.org/ci/badges/flarum.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/flarum.maintain.svg)

[![Install Flarum with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flarum)

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

> *This package allows you to install Flarum 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

Flarum is a simple discussion platform for your website. It's fast and easy to use, with all the features you need to run a successful community.

**Shipped version:** 1.8.5~ynh1

**Demo:** <https://discuss.flarum.org/d/21101-demos-come-to-flarum>

## Screenshots

![Screenshot of Flarum](./doc/screenshots/beta16.jpg)

## Documentation and resources

- Official app website: <https://flarum.org>
- Official admin documentation: <https://docs.flarum.org>
- Upstream app code repository: <https://github.com/flarum/framework>
- YunoHost Store: <https://apps.yunohost.org/app/flarum>
- Report a bug: <https://github.com/YunoHost-Apps/flarum_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/flarum_ynh/tree/testing).

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

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/flarum_ynh/tree/testing --debug
or
sudo yunohost app upgrade flarum -u https://github.com/YunoHost-Apps/flarum_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>