11# ANS - RESSOURCES
2+
23### Design System de l'ANS
34
45---
56
67Framework CSS créé par les équipes front d'Alterway.
78Maintenu par Klee Interactive.
9+
810- BEM pour le nommage des class et id
911- SASS pour le CSS
1012- jQuery ou Vanilla JS selon le besoin
@@ -15,65 +17,84 @@ Maintenu par Klee Interactive.
1517## Génération du projet
1618
1719Pour la première fois
20+
1821```
1922fin init
2023```
2124
2225Pour recompiler le guide de style
26+
2327```
2428fin compile
2529```
2630
2731Pour lancer la commande manuellement :
32+
2833```
2934fin gulp
3035```
3136
3237Pour lancer avec le watcher
38+
3339```
3440fin watch
3541```
3642
3743### Si le GULP plante
3844
3945Faire :
46+
4047```
4148rm -rf node_modules
4249rm -rf package-lock.json
4350fin npm cache clean --force
4451fin npm install
4552```
53+
4654---
55+
4756# Les grands principes
4857
4958### Base
59+
5060- Héritage de Boostrap 4.x.x
5161- OOCSS et BEM
5262- Architecture en Atomic Design
5363- Compilation via Gulp 4.x.x
5464
5565### Javascript
66+
5667Les plugins JS sont en jQuery pour la majorité d'entre eux.
5768Ils respectent les patterns d'accessibilité.
5869
5970### Accessibilité
71+
6072Respecter le RGAA, coder de façon accessible tant en HTML (twig), en CSS et en JS.
6173
6274### Composants
75+
6376- dossier TWIG des composants : ` web/twig/site/component ` .
6477- dossier CSS des composants : ` web/style/site/5-component ` .
6578
6679Faire correspondre au maximum les noms de fichiers CSS et TWIG, ainsi que les class du composant.
6780
6881Ex. du composant qui a pour class ` .a-info ` :
82+
6983- création du .twig : ` web/twig/site/component/1-atom/a-info.twig `
7084- création du .scss : ` web/style/site/5-component/1-atom/_a-info.scss `
7185
86+ # Gestion des css
87+
88+ La css style-ans.css est la css principale du site.
89+ La css styleguide.css concerne que le guide de style et écrase style-ans.css.
90+ En cas de modification ou de création de composant il est important donc de modifier les fichiers de twig/site et non pas twig/styleguide.
91+
7292---
7393
7494# Mise à jour de version officiel du projet
7595
7696A chaque mise à jour de version :
97+
7798- Modèle : X:Y: Z (ex: 1.9.0)
7899- Mettre à jour la date de livraison et le numéro de version sur la page ` index.twig `
79100- Lister tous les nouveaux éléments et les modifications apportées par la version sur la page ` sg-versions.twig `
@@ -85,5 +106,6 @@ A chaque mise à jour de version :
85106# Déploiement vers le GitHub ANS
86107
87108Après que le tag ai été validé par l'ANS sur les environnement OVH (préprod ou prod)
109+
88110- Créer une MR de develop au niveau du tag vers la branche "synchro-github-ans"
89- - Le push vers github se fait via un job "synchro_github" manuel.
111+ - Le push vers github se fait via un job "synchro_github" manuel.
0 commit comments