|
1 | 1 | # ANS - RESSOURCES |
| 2 | + |
2 | 3 | ### Design System de l'ANS |
3 | 4 |
|
4 | 5 | --- |
5 | 6 |
|
6 | 7 | Framework CSS créé par les équipes front d'Alterway. |
7 | 8 | Maintenu par Klee Interactive. |
| 9 | + |
8 | 10 | - BEM pour le nommage des class et id |
9 | 11 | - SASS pour le CSS |
10 | 12 | - jQuery ou Vanilla JS selon le besoin |
11 | 13 | - Accessibilité : RGAA (AA) exigé |
12 | 14 | - GULP 4.x.x |
13 | 15 | - Docksal |
14 | 16 |
|
15 | | -## Génération du projet |
16 | | - |
17 | | -Pour la première fois |
18 | | -``` |
19 | | -fin init |
20 | | -``` |
21 | | - |
22 | | -Pour recompiler le guide de style |
23 | | -``` |
24 | | -fin compile |
25 | | -``` |
26 | | - |
27 | | -Pour lancer la commande manuellement : |
28 | | -``` |
29 | | -fin gulp |
30 | | -``` |
31 | | - |
32 | | -Pour lancer avec le watcher |
33 | | -``` |
34 | | -fin watch |
35 | | -``` |
36 | | - |
37 | | -### Si le GULP plante |
38 | | - |
39 | | -Faire : |
40 | | -``` |
41 | | -rm -rf node_modules |
42 | | -rm -rf package-lock.json |
43 | | -fin npm cache clean --force |
44 | | -fin npm install |
45 | | -``` |
46 | 17 | --- |
| 18 | + |
47 | 19 | # Les grands principes |
48 | 20 |
|
49 | 21 | ### Base |
| 22 | + |
50 | 23 | - Héritage de Boostrap 4.x.x |
51 | 24 | - OOCSS et BEM |
52 | 25 | - Architecture en Atomic Design |
53 | 26 | - Compilation via Gulp 4.x.x |
54 | 27 |
|
55 | 28 | ### Javascript |
| 29 | + |
56 | 30 | Les plugins JS sont en jQuery pour la majorité d'entre eux. |
57 | 31 | Ils respectent les patterns d'accessibilité. |
58 | 32 |
|
59 | 33 | ### Accessibilité |
| 34 | + |
60 | 35 | Respecter le RGAA, coder de façon accessible tant en HTML (twig), en CSS et en JS. |
61 | 36 |
|
62 | 37 | ### Composants |
| 38 | + |
63 | 39 | - dossier TWIG des composants : `web/twig/site/component`. |
64 | 40 | - dossier CSS des composants : `web/style/site/5-component`. |
65 | 41 |
|
66 | 42 | Faire correspondre au maximum les noms de fichiers CSS et TWIG, ainsi que les class du composant. |
67 | 43 |
|
68 | 44 | Ex. du composant qui a pour class `.a-info` : |
| 45 | + |
69 | 46 | - création du .twig : `web/twig/site/component/1-atom/a-info.twig` |
70 | 47 | - création du .scss : `web/style/site/5-component/1-atom/_a-info.scss` |
71 | 48 |
|
72 | | ---- |
| 49 | +### Gestion des css |
| 50 | + |
| 51 | +Le fichier style-ans.css est la feuille de style css principale du site. |
| 52 | + |
| 53 | +Le fichier styleguide.css concerne le guide de style. Il écrase style-ans.css pour des styles spécifiques au site guide de style. |
| 54 | + |
| 55 | +En cas de modification ou de création de composant, il est important donc de modifier les fichiers scss de style/site et non pas style/styleguide. |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +# Section technique |
| 60 | + |
| 61 | +- Pour la première fois : ```fin init``` |
| 62 | +- Pour recompiler le guide de style : ```fin compile``` |
| 63 | +- Pour lancer la commande manuellement : ```fin gulp``` |
| 64 | +- Pour lancer avec le watcher : ```fin watch``` |
73 | 65 |
|
74 | | -# Mise à jour de version officiel du projet |
| 66 | + |
| 67 | +- Si le GULP plante : |
| 68 | + |
| 69 | +``` |
| 70 | +rm -rf node_modules |
| 71 | +rm -rf package-lock.json |
| 72 | +fin npm cache clean --force |
| 73 | +fin npm install |
| 74 | +``` |
| 75 | + |
| 76 | +## Mise à jour de version officiel du projet |
75 | 77 |
|
76 | 78 | A chaque mise à jour de version : |
| 79 | + |
77 | 80 | - Modèle : X:Y:Z (ex: 1.9.0) |
78 | 81 | - Mettre à jour la date de livraison et le numéro de version sur la page `index.twig` |
79 | 82 | - Lister tous les nouveaux éléments et les modifications apportées par la version sur la page `sg-versions.twig` |
80 | | -- Lancer la commande `fin gulp` pour générer tous les fichiers puis zipper la version (les éléments du dossier `web/styleguide`) **en retirant les .zip des anciennes versions du dossier /zip** |
81 | | -- Placer le nouveau fichier .zip dans le dossier `web/src/zip` |
| 83 | +- Lancer la commande `fin gulp` pour générer tous les fichiers puis zipper la version (les éléments du dossier `styleguide`) **en retirant les .zip des anciennes versions du dossier styleguide/zip** |
| 84 | + - ```cd styleguide && zip -r ../src/zip/ans-design-system-v1.0.1.zip .``` |
| 85 | +- Vérifier le nouveau fichier .zip dans le dossier `src/zip` |
82 | 86 | - Vérifier le poids noté dans les twig de tous les fichiers zip. Vous obtiendrez ces informations dans la console en lançant la commande `fin gulp` (fonction zipSizes) |
83 | 87 | - Taguer la branch `develop` à chaque livraison de version |
84 | 88 |
|
85 | | -# Déploiement vers le GitHub ANS |
| 89 | +## Déploiement vers le GitHub ANS |
86 | 90 |
|
87 | 91 | Après que le tag ai été validé par l'ANS sur les environnement OVH (préprod ou prod) |
| 92 | + |
88 | 93 | - Créer une MR de develop au niveau du tag vers la branche "synchro-github-ans" |
89 | 94 | - Le push vers github se fait via un job "synchro_github" manuel. |
0 commit comments