docs: mise à jour du README et ajout de la configuration CI Woodpecker
- Réécriture complète du README pour le projet stand-alone Techradar Laplank - Ajout de .woodpecker.yml pour la pipeline CI/CD - Mise à jour du .gitignore pour exclure les dossiers docs/ Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
220
Readme.md
220
Readme.md
@@ -1,52 +1,168 @@
|
||||
# AJR Technology Radar - Content
|
||||
# Techradar Laplank
|
||||
|
||||
Ce dépôt contient le contenu du Technology Radar AJR, publié sous : https://www.coeurbox.syoul.fr
|
||||
**Techradar Laplank** est un Technology Radar interactif pour suivre l'évolution des technologies de l'écosystème Laplank/Duniter/Ğ1. Le projet est basé sur le framework [aoe_technology_radar](https://github.com/AOEpeople/aoe_technology_radar), dont le code source est vendu dans le répertoire `radar-app/`.
|
||||
|
||||
Le projet est basé sur le framework [aoe_technology_radar](https://github.com/AOEpeople/aoe_technology_radar), dont le code source est vendu dans le répertoire `radar-app/`.
|
||||
## 🎯 Vue d'ensemble
|
||||
|
||||
## Vue d'ensemble
|
||||
**Techradar Laplank** est un projet **stand-alone** qui présente :
|
||||
- **38 technologies** organisées par quadrants business et anneaux d'adoption
|
||||
- **12 membres d'équipe** avec leurs compétences et projets
|
||||
- **Visualisations interactives** : graphe réseau, matrice de congestion, équipe de genèse
|
||||
- **Pages de stratégie** : Technique, Business, DataViz Expert
|
||||
|
||||
Le projet contient deux radars distincts :
|
||||
### Technologies utilisées
|
||||
|
||||
1. **Radar Technique Principal** : Radar standard des technologies utilisées par AJR
|
||||
2. **Radar Technologique Laplank** : Tech radar classique pour suivre l'évolution des technologies de l'écosystème Laplank/Duniter/Ğ1 avec historique par release
|
||||
- **Next.js** : 16.1.6 (avec Turbopack)
|
||||
- **React** : 19
|
||||
- **TypeScript** : 5
|
||||
- **Cytoscape.js** : Visualisation du graphe réseau
|
||||
- **ECharts** : Matrice de congestion
|
||||
- **Node.js** : 20+
|
||||
|
||||
## Radar Technologique Laplank
|
||||
## 🚀 Démarrage rapide
|
||||
|
||||
Le Radar Technologique Laplank est un tech radar classique accessible via le port **3006** avec une **protection par mot de passe** (`laplank-radar`).
|
||||
### Prérequis
|
||||
|
||||
### Fonctionnalités
|
||||
- Node.js 20 ou supérieur
|
||||
- npm ou yarn
|
||||
- Docker (pour le déploiement)
|
||||
|
||||
- **Historique par release** : Suivi de l'évolution des technologies au fil du temps avec organisation par date
|
||||
- **Pages de stratégie dynamiques** : Accès à trois pages de stratégie depuis le header :
|
||||
- Stratégie Technique
|
||||
- Business
|
||||
- DataViz Expert
|
||||
- **Protection par mot de passe** : Accès restreint via un système d'authentification client-side
|
||||
- **Quadrants business** : Classification selon l'impact business (Différenciantes, Commodité, Risque, Émergentes)
|
||||
- **Anneaux classiques** : Hold, Assess, Trial, Adopt
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
git clone gitea@git.open.us.org:AJR/TechradarDev.git
|
||||
cd TechradarDev
|
||||
npm install
|
||||
```
|
||||
|
||||
### Développement local
|
||||
|
||||
**Mode développement Next.js** (avec hot-reload) :
|
||||
```bash
|
||||
npm run serve-dev
|
||||
```
|
||||
Le serveur démarre sur http://localhost:3000
|
||||
|
||||
**Mode production local** (serveur statique) :
|
||||
```bash
|
||||
npm install
|
||||
npm run serve-business
|
||||
```
|
||||
|
||||
Le serveur démarre sur http://localhost:3006
|
||||
|
||||
### Déploiement
|
||||
**Build de production** :
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
Les fichiers statiques sont générés dans le répertoire `build/`
|
||||
|
||||
Le Radar Technologique Laplank est déployé via Docker et Portainer :
|
||||
## 🐳 Déploiement Docker
|
||||
|
||||
Le radar est déployé via Docker Compose :
|
||||
|
||||
**Commande de déploiement :**
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.business.yml up -d --build
|
||||
```
|
||||
|
||||
Cette commande :
|
||||
- Build l'image Docker sans cache (`--build`)
|
||||
- Démarre le conteneur en mode détaché (`-d`)
|
||||
- Le radar sera accessible sur http://localhost:3006
|
||||
|
||||
**Arrêter le déploiement :**
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.business.yml down
|
||||
```
|
||||
|
||||
**Configuration Docker :**
|
||||
- **Dockerfile** : `Dockerfile.business`
|
||||
- **Docker Compose** : `docker-compose.business.yml`
|
||||
- **Port** : 3006 (mappé depuis le port 3000 du conteneur)
|
||||
- **Base path** : `/` (racine)
|
||||
- **Conteneur** : `laplank-radar-technolologique`
|
||||
|
||||
## Content Guidelines
|
||||
## 📊 Fonctionnalités
|
||||
|
||||
Les nouveaux blips doivent être tagués. Les tags suivants sont établis :
|
||||
### Radar Technologique
|
||||
|
||||
- **Quadrants business** :
|
||||
- Technologies Différenciantes
|
||||
- Technologies Commodité
|
||||
- Technologies Risque
|
||||
- Technologies Émergentes
|
||||
|
||||
- **Anneaux d'adoption** :
|
||||
- **Adopt** : Technologies adoptées et utilisées en production
|
||||
- **Trial** : Technologies en phase d'essai
|
||||
- **Assess** : Technologies à évaluer
|
||||
- **Hold** : Technologies à éviter ou remplacer
|
||||
|
||||
- **38 technologies** suivies dans la release 2025-01-15
|
||||
|
||||
### Page Équipe (`/team`)
|
||||
|
||||
Visualisations interactives de l'équipe :
|
||||
|
||||
1. **Graphe réseau** : Relations entre membres et technologies (Cytoscape.js)
|
||||
2. **Matrice de congestion** : Technologies core vs disponibilité de l'équipe (ECharts)
|
||||
3. **Équipe de genèse** : Membres fondateurs et leurs compétences
|
||||
4. **Profils cliquables** : Cartes de profil détaillées pour chaque membre
|
||||
|
||||
**12 membres** de l'équipe avec leurs compétences, projets et disponibilités.
|
||||
|
||||
### Pages de stratégie
|
||||
|
||||
Accès à trois pages de stratégie depuis le header :
|
||||
- **Stratégie Technique** : Vision technique et roadmap
|
||||
- **Business** : Impact business et métriques
|
||||
- **DataViz Expert** : Stratégie de visualisation de données
|
||||
|
||||
**Protection par mot de passe** : `laplank-radar`
|
||||
|
||||
## 📁 Structure du projet
|
||||
|
||||
```
|
||||
TechradarDev/
|
||||
├── radar-app/ # Framework Next.js vendu (stand-alone)
|
||||
│ ├── src/ # Code source Next.js
|
||||
│ ├── data/ # Données du radar
|
||||
│ └── package.json # Next.js 16.1.6, React 19
|
||||
├── radar-business/ # Contenu du radar business
|
||||
│ ├── 2025-01-15/ # Release actuelle (38 technologies)
|
||||
│ └── config-business.json # Configuration du radar
|
||||
├── docs/
|
||||
│ ├── data/
|
||||
│ │ └── team/ # Profils des 12 membres
|
||||
│ └── app/ # Documentation technique
|
||||
├── scripts/
|
||||
│ ├── build-radar.js # Script de build stand-alone
|
||||
│ ├── serve-radar.js # Script de serve
|
||||
│ ├── generate-team-visualization-data.js # Génération données équipe
|
||||
│ └── ...
|
||||
├── public/ # Fichiers statiques
|
||||
│ ├── team-block-script.js # Script page équipe
|
||||
│ └── team-visualization-data.json # Données visualisations
|
||||
├── Dockerfile.business # Dockerfile pour déploiement
|
||||
└── docker-compose.business.yml # Configuration Docker Compose
|
||||
```
|
||||
|
||||
## 🛠️ Scripts disponibles
|
||||
|
||||
| Script | Description |
|
||||
|--------|-------------|
|
||||
| `npm run build` | Build de production (génère `build/`) |
|
||||
| `npm run serve` | Serve les fichiers statiques depuis `build/` |
|
||||
| `npm run serve-dev` | Mode développement Next.js (hot-reload) |
|
||||
| `npm run serve-business` | Serve le radar business en local (port 3006) |
|
||||
| `npm run extract-tech` | Extraction des technologies depuis la doc |
|
||||
| `npm run analyze-business` | Analyse des métriques business |
|
||||
|
||||
## 📝 Content Guidelines
|
||||
|
||||
### Tags disponibles
|
||||
|
||||
Les blips doivent être tagués avec les tags suivants :
|
||||
|
||||
* architecture
|
||||
* security
|
||||
@@ -59,35 +175,45 @@ Les nouveaux blips doivent être tagués. Les tags suivants sont établis :
|
||||
* ux/ui
|
||||
* documentation
|
||||
|
||||
Exemple d'utilisation :
|
||||
|
||||
```md
|
||||
Exemple :
|
||||
```markdown
|
||||
tags: [devops, security]
|
||||
```
|
||||
|
||||
## Development
|
||||
### Format des blips
|
||||
|
||||
### Build le radar principal
|
||||
```
|
||||
npm install
|
||||
npm run serve
|
||||
```
|
||||
Voir `radar-business/FORMAT-BLIP.md` pour le format complet des métadonnées business.
|
||||
|
||||
Puis ouvrir : http://localhost:3000/techradar
|
||||
## 🔐 Sécurité
|
||||
|
||||
### Build avec fichiers statiques
|
||||
```
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
- **Protection par mot de passe** : Les pages de stratégie sont protégées par le mot de passe `laplank-radar`
|
||||
- **Authentification client-side** : Système d'authentification JavaScript côté client
|
||||
|
||||
## Documentation
|
||||
## 📚 Documentation
|
||||
|
||||
La documentation complète est disponible dans le dossier `docs/` :
|
||||
|
||||
- [Architecture](./docs/app/architecture.md)
|
||||
- [Configuration](./docs/app/configuration.md)
|
||||
- [Développement](./docs/app/developpement.md)
|
||||
- [Déploiement](./docs/app/deploiement.md)
|
||||
- [Contribution](./docs/app/contribution.md)
|
||||
- [Guide Radar Technologique Laplank](./docs/app/guide-radar-business.md)
|
||||
- [Architecture](./docs/app/architecture.md) - Architecture technique du projet
|
||||
- [Configuration](./docs/app/configuration.md) - Configuration du radar
|
||||
- [Développement](./docs/app/developpement.md) - Guide de développement
|
||||
- [Déploiement](./docs/app/deploiement.md) - Guide de déploiement
|
||||
- [Contribution](./docs/app/contribution.md) - Guide de contribution
|
||||
- [Guide Radar Business](./docs/app/guide-radar-business.md) - Guide spécifique au radar business
|
||||
- [Guide Page Équipe](./docs/app/guide-page-equipe.md) - Documentation de la page équipe
|
||||
- [Migration Next.js 16](./docs/app/migration-nextjs-16.md) - Notes de migration
|
||||
|
||||
## 🔄 État du projet
|
||||
|
||||
- **Branche actuelle** : `stand-alone`
|
||||
- **Version** : 4.3.0
|
||||
- **Statut** : Projet stand-alone, indépendant du package externe `aoe_technology_radar`
|
||||
- **Framework** : Code vendu dans `radar-app/` (basé sur aoe_technology_radar)
|
||||
|
||||
## 📞 Support
|
||||
|
||||
- **Dépôt Git** : https://git.open.us.org/AJR/TechradarDev
|
||||
- **Radar en ligne** : http://localhost:3006 (après déploiement)
|
||||
|
||||
## 📄 Licence
|
||||
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user