1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/invoiceninja5_ynh.git synced 2024-09-03 19:26:23 +02:00
invoiceninja5_ynh/README.md

68 lines
2.6 KiB
Markdown
Raw Normal View History

2021-07-26 11:54:08 +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.
-->
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
# InvoiceNinja 5 for YunoHost
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
[![Integration level](https://dash.yunohost.org/integration/invoiceninja5.svg)](https://dash.yunohost.org/appci/app/invoiceninja5) ![](https://ci-apps.yunohost.org/ci/badges/invoiceninja5.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/invoiceninja5.maintain.svg)
[![Install InvoiceNinja 5 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=invoiceninja5)
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
> *This package allows you to install InvoiceNinja 5 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.*
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
## Overview
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
Create and email invoices, track payments, expenses, and time tasks
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
**Shipped version:** 5.2.14~ynh1
2020-11-15 21:54:22 +01:00
2021-07-26 11:56:56 +02:00
**Demo:** https://app.invoiceninja.com/dashboard
2020-11-15 21:54:22 +01:00
2021-07-26 11:56:56 +02:00
## Screenshots
![](./doc/screenshots/Create-Invoices-in-Seconds.png)
## Disclaimers / important information
### Warning
This is the new version of InvoiceNinja. There are several things not working at the moment:
* migration from v4
* installation into a sub-directory
* sending mails
Invoice Ninja is the #1 open-source platform to create & email invoices, track payments and expenses, and time billable tasks & projects for clients.
## YunoHost specific features
#### Multi-user support
* There is no official LDAP support
* The first user gets created after installing Invoice Ninja
* Other users can be created from inside the application
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
## Documentation and resources
2020-11-15 21:54:22 +01:00
2021-07-26 11:56:56 +02:00
* Official app website: https://invoiceninja.org
* Official user documentation: https://yunohost.org/apps
* Official admin documentation: https://docs.invoiceninja.com/index.html
* Upstream app code repository: https://github.com/invoiceninja/invoiceninja
2021-07-26 11:54:08 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_invoiceninja5
* Report a bug: https://github.com/YunoHost-Apps/invoiceninja5_ynh/issues
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
## Developer info
2020-11-15 21:54:22 +01:00
2021-07-26 11:54:08 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/invoiceninja5_ynh/tree/testing).
2020-11-15 21:54:22 +01:00
To try the testing branch, please proceed like that.
```
2021-07-26 11:54:08 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/invoiceninja5_ynh/tree/testing --debug
2020-11-15 21:54:22 +01:00
or
2021-07-26 11:54:08 +02:00
sudo yunohost app upgrade invoiceninja5 -u https://github.com/YunoHost-Apps/invoiceninja5_ynh/tree/testing --debug
2020-11-15 21:54:22 +01:00
```
2021-07-26 11:54:08 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps