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

# InvoiceNinja for YunoHost

[![Integration level](https://dash.yunohost.org/integration/invoiceninja.svg)](https://dash.yunohost.org/appci/app/invoiceninja) ![Working status](https://ci-apps.yunohost.org/ci/badges/invoiceninja.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/invoiceninja.maintain.svg)  
[![Install InvoiceNinja with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=invoiceninja)

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

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

Invoice Ninja is the #1 open-source platform to create & email invoices, track payments and expenses, and time billable tasks & projects for clients.


**Shipped version:** 4.5.50~ynh1


**Demo:** https://app.invoiceninja.com/dashboard

## Screenshots

![Screenshot of InvoiceNinja](./doc/screenshots/screenshot.png)

## Disclaimers / important information

:warning: You are invited to look at [InvoiceNinja 5](https://github.com/YunoHost-Apps/invoiceninja5_ynh) :warning:

* Any known limitations, constrains or stuff not working, such as (but not limited to):
    * There is no official LDAP support
    * The first user gets created after installing Invoice Ninja
    * Other users can be created from inside the application

* Other infos that people should be aware of, such as:
    * Configuration happens in the application itself.

## Documentation and resources

* Official app website: <https://invoiceninja.org>
* Official admin documentation: <https://docs.invoiceninja.com/index.html>
* Upstream app code repository: <https://github.com/invoiceninja/invoiceninja>
* YunoHost documentation for this app: <https://yunohost.org/app_invoiceninja>
* Report a bug: <https://github.com/YunoHost-Apps/invoiceninja_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

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