skeleton/README.md

61 lines
1.7 KiB
Markdown

# Application [4NK] - Interface Web
Cette application React fournit une interface pour interagir avec la plateforme [4NK]. Elle permet l'authentification des utilisateurs, la création de profils et de dossiers, ainsi que la visualisation des processus.
## Fonctionnalités principales
- Authentification utilisateur via OAuth
- Création et gestion de profils utilisateur
- Création et gestion de dossiers
- Visualisation des processus
- Console de messages pour le suivi des événements
## Prérequis
- Node.js (version 18 ou supérieure)
- npm ou yarn
## Installation
Pour installer les dépendances du projet, exécutez :
```bash
npm install
```
## Commandes disponibles
### Démarrage de l'application
**Commande principale** pour lancer l'application en mode développement :
```bash
npm run dev
```
L'application sera accessible à l'adresse : http://localhost:5173
## Communication avec la plateforme [4NK]
L'application communique avec la plateforme [4NK] via une iframe et un bus de messages. La communication est gérée par les classes `MessageBus` et `EventBus` dans le dossier `/src/sdk`.
## Configuration
L'URL de l'iframe est définie dans `App.tsx` :
```typescript
const iframeUrl = '<PUBLIC_BASE_URL>'
```
Pour modifier l'environnement cible, vous devez changer cette URL.
## 📋 Fichiers centralisés
Les fichiers suivants sont centralisés dans le dépôt principal `4NK_env` :
- `CODE_OF_CONDUCT.md` - Code de conduite
- `CODEOWNERS` - Propriétaires du code
- `CONTRIBUTING.md` - Guide de contribution
- `LICENSE` - Licence du projet
Voir : [`4NK_env/CODE_OF_CONDUCT.md`](../../CODE_OF_CONDUCT.md), [`4NK_env/CODEOWNERS`](../../CODEOWNERS), [`4NK_env/CONTRIBUTING.md`](../../CONTRIBUTING.md), [`4NK_env/LICENSE`](../../LICENSE)