Files
paycheck/README.md
2026-01-20 09:57:07 +01:00

140 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 🐷 Paycheck <small><em>Give me my fuc\*\* money.</em></small>
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.
---
## ✨ Fonctionnalités
- 📥 Import de fichiers Excel (.xlsx)
- 👤 Sélection dun agent (nom, prénom, matricule)
- 🧮 Calcul automatique des montants dastreintes selon un profil
- 🧾 Détail clair des lignes de rémunération
- 📄 Export PDF
- 🖥️ Application multiplateforme (Windows / Linux)
---
## 🧱 Socle technique
- 🧠 Go (backend et logique métier)
- 🪟 Wails v2 (application desktop)
- 🎨 JavaScript / HTML / CSS (frontend)
- 📄 gofpdf (génération PDF)
- ⚡ Vite (build frontend)
---
## 🚀 Utilisation
### ▶️ Utiliser le binaire
Télécharger le binaire correspondant à votre système depuis la page Releases du dépôt.
- 🪟 Windows : paycheck.exe
- 🐧 Linux : paycheck
Aucune installation supplémentaire nest nécessaire.
---
## 🛠️ Développement
### 🔧 Prérequis
- Go 1.21 ou plus récent
- Node.js 18 ou plus récent
- Wails CLI v2
Vérification de lenvironnement :
wails doctor
### ▶️ Lancer en mode développement
wails dev
---
## 🏗️ Build de lapplication
### 🐧 Linux
wails build
### 🪟 Windows
wails build -platform windows/amd64
Les binaires sont générés dans le dossier :
build/bin/
---
## 📄 Export PDF
Lexport PDF inclut :
- 🏷️ Titre
- 📅 Mois de paie
- 🧑 Identité de lagent
- 📐 Profil appliqué
- 📋 Détail ligne par ligne des montants
- 💰 Total brut
- 🧾 Légende des codes de paie
- 🕒 Pied de page avec date dexport
Le PDF est volontairement monopage, stable et prêt à être transmis.
---
## 📁 Structure du projet
paycheck/
- main.go
- wails.json
- go.mod
- internal/
- models/
- pdf/
- frontend/
- src/
- wailsjs/
- build/
- windows/
- README.md
---
## 🧭 Versioning
Ce projet suit le Semantic Versioning.
- 🏁 v1.0.0 : première version stable
- vX.Y.Z
- X : changement majeur
- Y : nouvelle fonctionnalité
- Z : correctif
---
## 👨‍💻 Auteur
Développé avec amour ❤️ par **Alban Dumerain** pour Flooze Corp - *A Niaremud Nablax Company*.
---
## 📜 Licence
Projet distribué tel quel.
Voir le fichier LICENSE si applicable.
---
## 🕰️ Historique
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.