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

# BookWyrm for YunoHost

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

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

*[Lire ce readme en français.](./README_fr.md)*

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

BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.


**Shipped version:** 0.5.4~ynh1

**Demo:** https://joinbookwyrm.com/fr/

## Screenshots

![Screenshot of BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)

## Disclaimers / important information

This project is still young and isn't, at the moment, very stable, so please proceed with caution when running in production.

Generate the admin code with sudo -u bookwyrm /var/www/bookwyrm/venv/bin/python3 /var/www/bookwyrm/manage.py admin_code, and copy the admin code to use when you create your admin account. You can get your code at any time by re-running that command. Here's an example output:

*******************************************
Use this code to create your admin account:
c6c35779-af3a-4091-b330-c026610920d6
*******************************************

## Documentation and resources

* Official app website: <https://joinbookwyrm.com/fr/>
* Official admin documentation: <https://docs.joinbookwyrm.com/>
* Upstream app code repository: <https://github.com/bookwyrm-social/bookwyrm>
* YunoHost documentation for this app: <https://yunohost.org/app_bookwyrm>
* Report a bug: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

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