Update README.md v0.3.0

This commit is contained in:
Noizette 2020-10-24 22:47:41 +00:00
parent 9897d10f6e
commit 99461358af

View File

@ -5,31 +5,37 @@ Source : https://gitlab.com/ramoloss/garradin-plugin-facturation
## Installation: ## Installation:
Vous pouvez télécharger l'archive depuis la page des [releases](https://gitlab.com/ramoloss/garradin-plugin-facturation/-/releases). Vous pouvez télécharger l'archive depuis la page des [releases](https://gitlab.com/ramoloss/garradin-plugin-facturation/-/releases).
Normalement, les plugins de Garradin doivent seulement être laissé sous forme d'archive .tar.gz dans le dossier plugins, or pour la génération des PDF, la librairie mPDF a besoin d'écrire des fichiers temporaires. Normalement, les plugins de Garradin doivent seulement être laissé sous forme d'archive .tar.gz dans le dossier plugins, or pour la génération des PDF, la librairie mPDF a besoin d'écrire des fichiers temporaires.
Il faut pour cela faire : Il faut pour cela faire :
tar xvf garradin-plugin-facturation-v0.2.0.tar.gz tar xvf garradin-plugin-facturation-v0.3.0.tar.gz
mv garradin-plugin-facturation-v0.2.0 facturation mv garradin-plugin-facturation-v0.3.0 facturation
rm garradin-plugin-facturation-v0.2.0.tar.gz rm garradin-plugin-facturation-v0.3.0.tar.gz
chown -R www-data:www-data facturation/ chown -R www-data:www-data facturation/
chmod -R g+w facturation/ chmod -R g+w facturation/
Supprimer l'archive permet à Garradin de ne pas la lire à la place du dossier. Supprimer l'archive permet à Garradin de ne pas la lire à la place du dossier.
Pour le moment, le fonctionnement du plugin se repose sur l'existence d'un champs « nom » (comme créé à l'installation de Garradin) dans les fiches membres. Celui-ci sert à remplir le champs du destinataire lorsqu'un document est adressé à un membre. S'il n'existe pas, la page « Nouveau document » renverra une erreur. *Note : www-data correspond dans la plupart des cas à l'utlisateur d'Apache, si vous utilisez un autre serveur web, il faudra probablement adapter.*
## Fonctionnalités : ## Fonctionnalités :
- Créer et gérer une base de client·es - Créer et gérer une base de client·es
- Créer et modifier des factures et devis adressés aux membres de l'association ou des client·es ajouté·es - Créer et modifier des factures et devis adressés aux membres de l'association ou des client·es ajouté·es
- Créer des reçus fiscaux pour des dons et génération du cerfa correspondant
- Créer des reçus sur des cotisations
- Génération des documents (facture et devis) en PDF grâce à la librairie mPDF - Génération des documents (facture et devis) en PDF grâce à la librairie mPDF
- Liste les documents associés sur la fiche d'un·e client·e - Liste les documents associés sur la fiche d'un·e client·e
- Permet de définir le statut du document sur reglée - Permet de définir le statut du document sur reglée
- **Configuration** : - **Configuration** :
- Possibilité d'ajouter le numéro de SIRET de l'association si elle en possède un (apparait alors sur les documents) - Possibilité d'ajouter un numéro RNA et SIRET de l'association si elle en possède (apparait alors sur les documents)
- Modification du pied de page des documents (notament pour y inscrire des mentions légales) - Modification du pied de page des documents (notament pour y inscrire des mentions légales)
- Vérifier le code postal : si coché, lors d'ajout ou de modification de client, le plugin vérifiera que le code postal entré est bien formaté (par rapport aux codes postaux français seulement) - Vérifier le code postal : si coché, lors d'ajout ou de modification de client, le plugin vérifiera que le code postal entré est bien formaté (par rapport aux codes postaux français seulement)
- Noms de client·es uniques : si coché, lors d'ajout ou de modicifation de client·e, le nom du/de la client·e ne pourra pas être le même que celui d'un·e client·e déjà existant - Noms de client·es uniques : si coché, lors d'ajout ou de modicifation de client·e, le nom du/de la client·e ne pourra pas être le même que celui d'un·e client·e déjà existant
- Informations relatives au cerfa pour les reçus fiscaux
- Image qui set de signature sur le cerfa
Note : pour le moment, les actions sur la liste des clients à cocher ne fonctionnent pas. Pour supprimer un client, le faire depuis sa fiche. Note : pour le moment, les actions sur la liste des clients à cocher ne fonctionnent pas. Pour supprimer un client, le faire depuis sa fiche.