Actualiser README.md
This commit is contained in:
78
README.md
78
README.md
@@ -1,4 +1,4 @@
|
|||||||
# Paycheck
|
# 🐷 Paycheck
|
||||||
|
|
||||||
Paycheck est une application desktop permettant de calculer, vérifier et exporter la rémunération des astreintes à partir des données de paie (Excel), selon des profils de règles configurables.
|
Paycheck est une application desktop permettant de calculer, vérifier et exporter la rémunération des astreintes à partir des données de paie (Excel), selon des profils de règles configurables.
|
||||||
|
|
||||||
@@ -6,43 +6,43 @@ Give me my fuc** money.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Fonctionnalités
|
## ✨ Fonctionnalités
|
||||||
|
|
||||||
- Import de fichiers Excel (.xlsx)
|
- 📥 Import de fichiers Excel (.xlsx)
|
||||||
- Sélection d’un agent (nom, prénom, matricule)
|
- 👤 Sélection d’un agent (nom, prénom, matricule)
|
||||||
- Calcul automatique des montants d’astreintes selon un profil
|
- 🧮 Calcul automatique des montants d’astreintes selon un profil
|
||||||
- Détail clair des lignes de rémunération
|
- 🧾 Détail clair des lignes de rémunération
|
||||||
- Export PDF professionnel avec branding Paycheck
|
- 📄 Export PDF professionnel avec branding Paycheck
|
||||||
- Application desktop multiplateforme (Windows / Linux)
|
- 🖥️ Application desktop multiplateforme (Windows / Linux)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Stack technique
|
## 🧱 Stack technique
|
||||||
|
|
||||||
- Go (backend et logique métier)
|
- 🧠 Go (backend et logique métier)
|
||||||
- Wails v2 (application desktop)
|
- 🪟 Wails v2 (application desktop)
|
||||||
- JavaScript / HTML / CSS (frontend)
|
- 🎨 JavaScript / HTML / CSS (frontend)
|
||||||
- gofpdf (génération PDF)
|
- 📄 gofpdf (génération PDF)
|
||||||
- Vite (build frontend)
|
- ⚡ Vite (build frontend)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Utilisation
|
## 🚀 Utilisation
|
||||||
|
|
||||||
### Utiliser le binaire
|
### ▶️ Utiliser le binaire
|
||||||
|
|
||||||
Télécharger le binaire correspondant à votre système depuis la page Releases du dépôt.
|
Télécharger le binaire correspondant à votre système depuis la page Releases du dépôt.
|
||||||
|
|
||||||
- Windows : paycheck.exe
|
- 🪟 Windows : paycheck.exe
|
||||||
- Linux : paycheck
|
- 🐧 Linux : paycheck
|
||||||
|
|
||||||
Aucune installation supplémentaire n’est nécessaire.
|
Aucune installation supplémentaire n’est nécessaire.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Développement
|
## 🛠️ Développement
|
||||||
|
|
||||||
### Prérequis
|
### 🔧 Prérequis
|
||||||
|
|
||||||
- Go 1.21 ou plus récent
|
- Go 1.21 ou plus récent
|
||||||
- Node.js 18 ou plus récent
|
- Node.js 18 ou plus récent
|
||||||
@@ -52,19 +52,19 @@ Vérification de l’environnement :
|
|||||||
|
|
||||||
wails doctor
|
wails doctor
|
||||||
|
|
||||||
### Lancer en mode développement
|
### ▶️ Lancer en mode développement
|
||||||
|
|
||||||
wails dev
|
wails dev
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build de l’application
|
## 🏗️ Build de l’application
|
||||||
|
|
||||||
### Linux
|
### 🐧 Linux
|
||||||
|
|
||||||
wails build
|
wails build
|
||||||
|
|
||||||
### Windows
|
### 🪟 Windows
|
||||||
|
|
||||||
wails build -platform windows/amd64
|
wails build -platform windows/amd64
|
||||||
|
|
||||||
@@ -74,24 +74,24 @@ build/bin/
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Export PDF
|
## 📄 Export PDF
|
||||||
|
|
||||||
L’export PDF inclut :
|
L’export PDF inclut :
|
||||||
|
|
||||||
- Titre de l'application
|
- 🏷️ Titre et branding Paycheck
|
||||||
- Mois de paie
|
- 📅 Mois de paie
|
||||||
- Identité de l’agent
|
- 🧑 Identité de l’agent
|
||||||
- Profil appliqué
|
- 📐 Profil appliqué
|
||||||
- Détail ligne par ligne des montants
|
- 📋 Détail ligne par ligne des montants
|
||||||
- Total brut
|
- 💰 Total brut
|
||||||
- Légende des codes de paie
|
- 🧾 Légende des codes de paie
|
||||||
- Pied de page avec date d’export
|
- 🕒 Pied de page avec date d’export
|
||||||
|
|
||||||
Le PDF est volontairement monopage, stable et prêt à être transmis.
|
Le PDF est volontairement monopage, stable et prêt à être transmis.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Structure du projet
|
## 📁 Structure du projet
|
||||||
|
|
||||||
paycheck/
|
paycheck/
|
||||||
- main.go
|
- main.go
|
||||||
@@ -109,11 +109,11 @@ paycheck/
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Versioning
|
## 🧭 Versioning
|
||||||
|
|
||||||
Ce projet suit le Semantic Versioning.
|
Ce projet suit le Semantic Versioning.
|
||||||
|
|
||||||
- v1.0.0 : première version stable
|
- 🏁 v1.0.0 : première version stable
|
||||||
- vX.Y.Z
|
- vX.Y.Z
|
||||||
- X : changement majeur
|
- X : changement majeur
|
||||||
- Y : nouvelle fonctionnalité
|
- Y : nouvelle fonctionnalité
|
||||||
@@ -121,7 +121,7 @@ Ce projet suit le Semantic Versioning.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Auteur
|
## 👨💻 Auteur
|
||||||
|
|
||||||
**Alban Dumerain** pour Flooze Corp - *A Niaremud Nablax Company*.
|
**Alban Dumerain** pour Flooze Corp - *A Niaremud Nablax Company*.
|
||||||
|
|
||||||
@@ -129,14 +129,14 @@ Développé avec amour ❤️ en Go.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Licence
|
## 📜 Licence
|
||||||
|
|
||||||
Projet distribué tel quel.
|
Projet distribué tel quel.
|
||||||
Voir le fichier LICENSE si applicable.
|
Voir le fichier LICENSE si applicable.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Historique
|
## 🕰️ Historique
|
||||||
|
|
||||||
Paycheck est la version renommée et stabilisée du projet initialement appelé calcul-astreintes.
|
Paycheck est la version renommée et stabilisée du projet initialement appelé calcul-astreintes.
|
||||||
À partir de la version 1.0, seul Paycheck est maintenu.
|
À partir de la version 1.0, seul Paycheck est maintenu.
|
||||||
Reference in New Issue
Block a user