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

# Soapbox for YunoHost

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

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

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

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

Soapbox is customizable open-source software that puts the power of social media in the hands of the people.
Feature-rich and hyper-focused on providing a user experience to rival Big Tech, Soapbox is already home to some of the biggest alternative social platforms.


**Shipped version:** 3.2.0~ynh1

## Screenshots

![Screenshot of Soapbox](./doc/screenshots/screenshot.jpg)

## Documentation and resources

- Official app website: <https://soapbox.pub/>
- Official admin documentation: <https://docs.soapbox.pub/>
- Upstream app code repository: <https://gitlab.com/soapbox-pub/soapbox-fe>
- YunoHost Store: <https://apps.yunohost.org/app/soapbox>
- Report a bug: <https://github.com/YunoHost-Apps/soapbox_ynh/issues>

## Developer info

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

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

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

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