firefly-iii_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.
-->

# Firefly III for YunoHost

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

[![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=firefly-iii)

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

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

Firefly III is a manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. Using external tools, ie [Firefly III Importer](https://github.com/YunoHost-Apps/firefly-iii-di_ynh), you can import data. It also has many neat financial reports available.


**Shipped version:** 6.0.10~ynh1

**Demo:** https://demo.firefly-iii.org/login

## Screenshots

![Screenshot of Firefly III](./doc/screenshots/imac-complete.png)

## Documentation and resources

* Official app website: <https://firefly-iii.org/>
* Official admin documentation: <https://docs.firefly-iii.org/firefly-iii/about-firefly-iii/introduction/>
* Upstream app code repository: <https://github.com/firefly-iii/firefly-iii>
* YunoHost documentation for this app: <https://yunohost.org/app_firefly-iii>
* Report a bug: <https://github.com/YunoHost-Apps/firefly-iii_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Auto-update README 2021-07-23 13:39:46 +02:00			`<!--`
			`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.`
			`-->`

Apply last example_ynh 2020-06-11 00:45:03 +02:00			`# Firefly III for YunoHost`
Reorganise readme content. 2018-06-18 19:03:28 +02:00
Auto-update README 2023-03-13 07:24:59 +01:00			`[![Integration level](https://dash.yunohost.org/integration/firefly-iii.svg)](https://dash.yunohost.org/appci/app/firefly-iii) ![Working status](https://ci-apps.yunohost.org/ci/badges/firefly-iii.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/firefly-iii.maintain.svg)`

Auto-update README 2021-07-23 13:39:46 +02:00			`[![Install Firefly III with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=firefly-iii)`

			`[Lire ce readme en français.](./README_fr.md)`
Updated Readme 2018-06-17 20:51:48 +02:00
Auto-update README 2021-07-23 13:39:46 +02:00			`> *This package allows you to install Firefly III quickly and simply on a YunoHost server.`
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
Updated Readme 2018-06-17 20:51:48 +02:00
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`## Overview`
Small textual changes in readme. Removed the todo-list since it's complete. 2018-06-18 18:39:23 +02:00
Auto-update README 2023-05-21 11:42:10 +02:00			`Firefly III is a manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. Using external tools, ie [Firefly III Importer](https://github.com/YunoHost-Apps/firefly-iii-di_ynh), you can import data. It also has many neat financial reports available.`
Auto-update README 2022-05-01 23:51:09 +02:00
Updated Readme 2018-06-17 20:51:48 +02:00
Auto-update README 2023-05-21 11:26:06 +02:00			`Shipped version: 6.0.10~ynh1`
Reorganise readme content. 2018-06-18 19:03:28 +02:00
Auto-update README 2021-07-23 15:01:57 +02:00			`Demo: https://demo.firefly-iii.org/login`
Small textual changes in readme. Removed the todo-list since it's complete. 2018-06-18 18:39:23 +02:00
Auto-update README 2021-07-23 14:57:11 +02:00			`## Screenshots`

Auto-update README 2022-06-01 18:25:59 +02:00			`![Screenshot of Firefly III](./doc/screenshots/imac-complete.png)`
Auto-update README 2021-07-23 14:57:11 +02:00
Auto-update README 2021-07-23 13:39:46 +02:00			`## Documentation and resources`
Add restrictions and TODO 2020-02-23 21:10:31 +01:00
Auto-update README 2022-06-01 18:25:59 +02:00			`* Official app website: <https://firefly-iii.org/>`
			`* Official admin documentation: <https://docs.firefly-iii.org/firefly-iii/about-firefly-iii/introduction/>`
			`* Upstream app code repository: <https://github.com/firefly-iii/firefly-iii>`
			`* YunoHost documentation for this app: <https://yunohost.org/app_firefly-iii>`
			`* Report a bug: <https://github.com/YunoHost-Apps/firefly-iii_ynh/issues>`
Apply last example_ynh 2020-06-11 00:45:03 +02:00
Small typos 2020-11-29 09:59:46 +01:00			`## Developer info`
Apply last example_ynh 2020-06-11 00:45:03 +02:00
			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing).`

			`To try the testing branch, please proceed like that.`
Auto-update README 2022-06-01 18:25:59 +02:00
			``` bash
Apply last example_ynh 2020-06-11 00:45:03 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade firefly-iii -u https://github.com/YunoHost-Apps/firefly-iii_ynh/tree/testing --debug`
			```
Auto-update README 2021-07-23 13:39:46 +02:00
Auto-update README 2022-06-01 18:25:59 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`