Skip to content

Commit 29dcb24

Browse files
committed
Update README.
1 parent a5a34fc commit 29dcb24

File tree

1 file changed

+35
-40
lines changed

1 file changed

+35
-40
lines changed

README.md

Lines changed: 35 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# S.K.E.L.E.T.O.R
22

3-
Framework CSS créé par les équipes front d'alterway.
3+
Framework CSS créé par les équipes front d'Alterway.
44
- BEM pour le nommage des class et id
55
- SASS pour le CSS
66
- jQuery ou Vanilla JS selon le besoin
@@ -9,70 +9,65 @@ Framework CSS créé par les équipes front d'alterway.
99

1010
# Génération du projet
1111

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
12+
Pour la première fois
1713
```
18-
- Le projet s'installe avec les dépendances node_modules
19-
- Lancer la commande :
20-
```javascript
21-
gulp
14+
fin init
2215
```
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_
2616

17+
Pour mettre à jour votre site
18+
```
19+
fin update-site
20+
```
2721

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)
22+
Pour lancer la commande manuellement :
23+
```
24+
fin gulp
25+
```
3726

38-
# Si gulp retourne cette erreur
27+
Pour lancer avec le watcher
28+
```
29+
fin watch
30+
```
3931

40-
gulpInst.start.apply(gulpInst, toRun);
32+
## Si le GULP plante
4133

4234
Faire :
43-
- npm i -g gulp-cli
44-
35+
- rm -rf node_modules
36+
- rm -rf package-lock.json
37+
- fin npm cache clean --force
38+
- fin npm install
4539

46-
## Les grands principes
40+
# Les grands principes
4741

48-
### Base
42+
## Base
4943
- Héritage de Boostrap 4.x.x
5044
- OOCSS et BEM
5145
- Architecture en Atomic Design
5246
- Compilation via Gulp 4.x.x
5347

54-
### Javascript
48+
## Javascript
5549
Les plugins JS sont en jQuery pour la majorité d'entre eux.
5650
Ils respectent les patterns d'accessibilité.
5751

58-
### Accessibilité
52+
## Accessibilité
5953
Respecter le RGAA, coder de façon accessible tant en HTML (twig), en CSS et en JS.
6054

61-
### Composants
62-
- dossier TWIG des composants : `twig/site/component`.
63-
- dossier CSS des composants : `style/site/5-component`.
55+
## Composants
56+
- dossier TWIG des composants : `web/twig/site/component`.
57+
- dossier CSS des composants : `web/style/site/5-component`.
6458

6559
Faire correspondre au maximum les noms de fichiers CSS et TWIG, ainsi que les class du composant.
6660

6761
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`
62+
- création du .twig : `web/twig/site/component/1-atom/a-info.twig`
63+
- création du .scss : `web/style/site/5-component/1-atom/_a-info.scss`
64+
65+
# Mise à jour de version
7066

71-
## Mise à jour de version
7267
A chaque mise à jour de version :
7368
- Mettre à jour la date de livraison et le numéro de version sur la page `index.twig`
7469
- 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
70+
- 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**
71+
- Placer le nouveau fichier .zip dans le dossier `web/src/zip`
72+
- 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)
73+
- Taguer la branch `develop` à chaque livraison de version

0 commit comments

Comments
 (0)