generator-lagrange

Scaffolding pour les projets de La Grange.

Compose la structure de base des projets chez La Grange. Contient donc la structure des dossiers, ainsi que les principales dépendances JavaScript et SCSS/CSS.

Pour installer le générateur yeoman de lagrange

Cloner le projet de generateur et y aller dans la console

git clone https://github.com/LaGrangeMtl/generator-lagrange.git
cd generator-lagrange

Y mettre une référence dans node_modules :

npm link

Installer le générateur

npm install -g generator-lagrange

Après on peut scaffolder en faisant

yo lagrange

Une fois scaffoldé, on doit rouler la procédure Grunt qui fait le prebuild, c'est à dire déplace les dépendances dans les bons dossiers, pour ne pas avoir à gitter les bower_components

grunt prebuild

Notes importantes

• AVANT DE yo lagrange UN PROJET, PULLEZ POUR ÊTRE SUR D'AVOIR LA BONNE VERSION
• Le scaffolding a des dépendances gérées par Bower, notamment le framework frontend. Pour être certain d'avoir la bonne version du framework, ce dernier doit être à jour.
• Lors d'un commit, le faire le plus clair possible et mettre en détail les choses longues à expliquer dans le champ description pour qu'on puisse suivre les modifications facilement.
• Il est important de bien documenter chaque ajout et modification majeure à ce projet qui affecte le workflow sur le système de documentation prévu à cet effet.

Structure des dossiers

/css

Fichiers .css seulement

---

/scss

Le fichier main.scss sera situé à la racine de ce dossier. Les autres fichiers .scss sont disposés selon cette structure :

• /common :

  Ici, les fichiers communs à tous les projets, ex: "responsive.scss", "reset.scss", etc.

• /website :

  Ici, les fichiers spécifiques à chaque projet, ex: "basic.scss", "header.scss", etc.

---

/img

Fichiers images seulement

---

/assets

Fonts et sons

---

/js

Le fichier main.js (app.js si le projet utilise Require.js) sera situé à la racine de ce dossier. Les autres fichiers .js sont disposés selon cette structure :

• /vendor :

  Ici, les snippets, librairies et classes dont le code source n'est pas propriété de La Grange. Même si une librairie est liscencié sous MIT ou autre liscence libre, elle doit être mise dans ce dossier par soucis de clarté.

• /lagrange :

  Ici, les snippets, librairies et classes propres à La Grange.

• /[nom de dossier relatif au projet] :

  Ici, le code et classes spécifiques au projet.