|
| 1 | +# S.K.E.L.E.T.O.R |
| 2 | + |
| 3 | +Framework CSS créé par les équipes front d'alterway. |
| 4 | +- BEM pour le nommage des class et id |
| 5 | +- SASS pour le CSS |
| 6 | +- jQuery ou Vanilla JS selon le besoin |
| 7 | +- Accessibilité : RGAA (AA) exigé |
| 8 | +- GULP 4.x.x |
| 9 | + |
| 10 | +# Génération du projet |
| 11 | + |
| 12 | +- Installer NodeJS _(version projet : 10.24.1)_ |
| 13 | +- Installer NPM _(version projet : 6.14.12)_ |
| 14 | +- Lancer la commande : |
| 15 | +```javascript |
| 16 | +npm install |
| 17 | +``` |
| 18 | +- Le projet s'installe avec les dépendances node_modules |
| 19 | +- Lancer la commande : |
| 20 | +```javascript |
| 21 | +gulp |
| 22 | +``` |
| 23 | +- Le _gulpfile.js_ est interprété |
| 24 | +- Le dossier *__public* est généré avec les pages statiques |
| 25 | +- Les assets (css, js, img) sont envoyés dans le thème selon le lien référencé dans le _gulpfile.js_ |
| 26 | + |
| 27 | + |
| 28 | +# Si le GULP plante |
| 29 | +Faire : |
| 30 | + |
| 31 | +- rm -rf node_modules |
| 32 | +- rm -rf package-lock.json |
| 33 | +- npm cache clean --force |
| 34 | +- npm install |
| 35 | + |
| 36 | +source : https://github.com/gulpjs/gulp/issues/2162#issuecomment-384885950(https://github.com/gulpjs/gulp/issues/2162#issuecomment-384885950) |
| 37 | + |
| 38 | +# Si gulp retourne cette erreur |
| 39 | + |
| 40 | +gulpInst.start.apply(gulpInst, toRun); |
| 41 | + |
| 42 | +Faire : |
| 43 | +- npm i -g gulp-cli |
| 44 | + |
| 45 | + |
| 46 | +## Les grands principes |
| 47 | + |
| 48 | +### Base |
| 49 | +- Héritage de Boostrap 4.x.x |
| 50 | +- OOCSS et BEM |
| 51 | +- Architecture en Atomic Design |
| 52 | +- Compilation via Gulp 4.x.x |
| 53 | + |
| 54 | +### Javascript |
| 55 | +Les plugins JS sont en jQuery pour la majorité d'entre eux. |
| 56 | +Ils respectent les patterns d'accessibilité. |
| 57 | + |
| 58 | +### Accessibilité |
| 59 | +Respecter le RGAA, coder de façon accessible tant en HTML (twig), en CSS et en JS. |
| 60 | + |
| 61 | +### Composants |
| 62 | +- dossier TWIG des composants : `twig/site/component`. |
| 63 | +- dossier CSS des composants : `style/site/5-component`. |
| 64 | + |
| 65 | +Faire correspondre au maximum les noms de fichiers CSS et TWIG, ainsi que les class du composant. |
| 66 | + |
| 67 | +Ex. du composant qui a pour class `.a-info` : |
| 68 | +- création du .twig : `twig/site/component/1-atom/a-info.twig` |
| 69 | +- création du .scss : `style/site/5-component/1-atom/_a-info.scss` |
| 70 | + |
| 71 | +## Mise à jour de version |
| 72 | +A chaque mise à jour de version : |
| 73 | +- Mettre à jour la date de livraison et le numéro de version sur la page `index.twig` |
| 74 | +- Lister tous les nouveaux éléments et les modifications apportées par la version sur la page `sg-versions.twig` |
| 75 | +- Lancer la commande `gulp` pour générer tous les fichiers puis zipper la version (les éléments du dossier `__public/styleguide`) **en retirant les .zip des anciennes versions du dossier /zip** |
| 76 | +- Placer le nouveau fichier .zip dans le dossier `src/zip` |
| 77 | +- 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 `gulp` (fonction zipSizes) |
| 78 | +- Taguer la branch master à chaque livraison de version |
0 commit comments