76 lines
3.2 KiB
Markdown
76 lines
3.2 KiB
Markdown
# KROW Workforce - Frontend
|
|
|
|
Ce projet contient le code du frontend pour la plateforme KROW Workforce. Il a été initialement prototypé sur la plateforme low-code Base44 et est en cours de migration vers une infrastructure backend personnalisée sur Google Cloud Platform (GCP).
|
|
|
|
Ce `README.md` est le guide officiel pour l'équipe de développement. **NE PAS REMPLACER** ce fichier par celui fourni dans les exports de Base44.
|
|
|
|
---
|
|
|
|
## 🚀 Démarrage Rapide
|
|
|
|
Ce projet utilise un `Makefile` comme point d'entrée principal pour toutes les commandes courantes.
|
|
|
|
### Prérequis
|
|
- Node.js (version LTS recommandée)
|
|
- npm
|
|
- `make` (généralement pré-installé sur Linux et macOS)
|
|
|
|
### Installation et Lancement
|
|
1. **Installer les dépendances :**
|
|
```bash
|
|
make install
|
|
```
|
|
|
|
2. **Lancer le serveur de développement :**
|
|
```bash
|
|
make dev
|
|
```
|
|
L'application sera disponible sur `http://localhost:5173`.
|
|
|
|
---
|
|
|
|
## Makefile - Commandes Disponibles
|
|
|
|
Utilisez `make help` pour voir toutes les commandes disponibles.
|
|
|
|
- `make install`: Installe les dépendances du projet.
|
|
- `make dev`: Lance le serveur de développement en local.
|
|
- `make build`: Construit l'application pour la production.
|
|
- `make prepare-export`: **(Workflow Hybride)** Applique les patchs nécessaires à un nouvel export de Base44.
|
|
|
|
---
|
|
|
|
## 🔄 Workflow d'Intégration des Mises à Jour de Base44
|
|
|
|
Pour intégrer les nouvelles modifications de l'UI faites par la cliente sur la plateforme Base44, suivez ce processus rigoureux :
|
|
|
|
### 1. Valider les Changements d'API
|
|
Avant de toucher au code, demandez au chat de Base44 la dernière documentation de l'API et des schémas. Comparez-la avec notre fichier `docs/api_specification.md` pour identifier tout changement qui impacterait le backend.
|
|
|
|
### 2. Intégrer le Nouveau Frontend
|
|
1. **Créez une branche dédiée** dans Git :
|
|
```bash
|
|
git checkout -b integration/base44-update-YYYY-MM-DD
|
|
```
|
|
2. Dans le nouvel export de Base44, **copiez le contenu du dossier `src`** et remplacez le dossier `src` de ce projet.
|
|
3. **Exécutez le script de préparation** pour neutraliser le SDK Base44 et appliquer nos patchs :
|
|
```bash
|
|
make prepare-export
|
|
```
|
|
4. **Analysez les différences** avec `git diff`. Intégrez les nouveaux composants et les modifications de l'UI, mais **rejetez les changements** sur les fichiers que nous avons patchés (`src/api/base44Client.js`, `src/main.jsx`, `src/pages/Layout.jsx`) pour conserver notre environnement local fonctionnel.
|
|
5. **Testez l'application** en local avec `make dev` pour vous assurer que tout fonctionne comme prévu.
|
|
6. Commitez vos changements.
|
|
|
|
---
|
|
|
|
## 📂 Structure du Projet
|
|
|
|
- `scripts/prepare-export.js`: Script de patching pour le workflow hybride.
|
|
- `docs/`: Contient la documentation du projet (spécification de l'API, guides...).
|
|
- `src/`: Code source de l'application.
|
|
- `src/api/`: Contient la configuration du client API (actuellement mocké).
|
|
- `src/components/`: Composants React réutilisables.
|
|
- `src/pages/`: Vues principales de l'application, correspondant aux routes.
|
|
- `src/lib/`: Utilitaires et bibliothèques partagées.
|
|
- `Makefile`: Orchestrateur des commandes du projet.
|