Tool box for static front-end developpement


License
MIT
Install
npm install @cleverage/gsk@3.0.0-alpha9

Documentation

Clever Garden Starter Kit

Ce dépôt GIT sert de kit de démarrage pour les projets d'intégration statique.

Il contient toutes nos bonnes pratiques et tous les outils nécessaires pour nos projets d'intégration statique chez Clever Age. Parmi tous les outils présents dans ce kit, vous trouverez ceux qui doivent être utilisés obligatoirement aussi bien que ceux qui sont simplement recommandés.

Chaque outil utilisé dispose d'une documentation dédiée sur la façon de l'utiliser dans notre contexte. Cette documentation est rédigée au format Markdown et est disponible dans le répertoire .gsk/docs de ce dépôt.

Créer un nouveau projet

Pour créer un nouveau projet, suivez simplement les instructions ci-après.

NOTE : Il s'agit ici des instructions manuelles à suivre. Cependant, à terme, il est prévu qu'un script d'installation soit disponible pour simplifier le démarage.

Vérifier votre environnement

Tous nos projets pré-supposent que votre environnement dispose des outils suivants installés au niveau global sur votre machine :

Pour Mac : vous devez obligatoirement installer XCode et les outils en ligne de commande qui l’accompagnent (ce qui installera automatiquement Ruby et Rubygems). Il est également recommandé d'installer et d'utiliser Homebrew pour installer tous les outils en ligne de commande dont vous pourriez avoir besoin.

Pour Windows : un des modules installés par Bundle nécessite une compilation en C. Pour cela, installez le Ruby Development Kit en suivant ces instructions.

Pour Linux : Chaque distribution a ses propre prérequis. Par exemple, Linux Mint 16 a besoin de ruby1.9.1-beta

Afin de pouvoir utiliser facilement les commandes fournies par npm (notamment gulp), installées dans votre répertoire projet (dans le dossier node_modules), plusieurs méthodes existent.

Solution 1 : ajout au PATH

La plus simple est d'ajouter le répertoire ./node_modules/.bin a votre PATH, mais suivant votre environnement, vous aurez peut-être besoin de le faire pour chaque projet.

Pour Mac/Linux, rajouter la ligne suivante dans votre fichier ~/.profile (Mac), ~/.bash_rc (Linux) ou tout autre fichier de configuration correspondant à votre shell, pour que le changement soit effectif à chaque lancement de votre terminal.

export PATH="./node_modules/.bin:$PATH"

Vous pourrez alors lancer directement depuis votre terminal les commandes :

$ gulp live

Solution 2 : méthode dédiée

Une autre solution valable d'un projet à l'autre est de définir une fonction dédiée dans votre profile de terminal qui ira à chaque fois lancer les commandes inhérentes au projet en cours.

Pour Mac/Linux, rajouter la fonction suivante dans votre fichier ~/.profile (Mac), ~/.bash_rc (Linux) ou tout autre fichier de configuration correspondant à votre shell, pour que le changement soit effectif à chaque lancement de votre terminal.

function npm-do {
    (PATH=$(npm bin):$PATH; eval $@;)
}

Vous pourrez alors lancer les commandes voulues par le biais de cette méthode :

$ npm-do gulp live

Démarrer votre projet

Vous avez deux options pour démarrer votre projet :

  1. Télécharger le contenu de ce dépôt et l'utiliser comme base de démarrage
  2. Clôner ce dépôt avec GIT (voir ci-après)

Clôner le kit de démarrage avec GIT

Si vous le souhaitez, vous pouvez directement clôner ce dépôt avec GIT.

Le plus simple :

$ cd ~/monProjet
$ git clone git@github.com:cleverage/garden-starter-kit.git .
$ rm -rf .git

Il ne vous reste plus qu'à initialiser le dépôt git de votre projet et commiter le starter kit que vous avez récupéré pour commencer votre projet :

$ git init
$ git add --all
$ git commit -m "First commit"
$ git remote add origin <URL-de-votre-depot-git>
$ git push -u origin master

Lors du démarrage de votre projet et à chaque fois que le dépôt est rapatrié en local, exécutez les commandes suivantes :

$ bundle install --path .gems
$ npm install

Organisation des fichiers

Pour harmoniser notre travail, tous les projets utiliseront la structure de fichiers suivante.

Les sources sur lesquelles nous travaillons sont toutes dans le répertoire src. Normalement, seuls les fichiers présents dans ce répertoire devraient être modifiés après le début du projet.

  • /src
  • /src/css : l'ensemble des fichiers qui produiront du CSS. Attention : Les dossiers contenant vos inclusions SASS doivent obligatoirement commencer par un ``_
  • /src/js : l'ensemble des sources JavaScript du projet
  • /src/assets : l'ensemble des fichiers qui doivent être utilisés par le projet en l'état.
  • /src/assets/img : l'ensemble des images d'interface du projet
  • /src/assets/sprites : l'ensemble des images d'interface qui seront regroupées en sprites
  • /src/assets/fonts : l'ensemble des fontes utilisées par le projet
  • /src/html : l'ensemble des gabarits qui produiront du HTML
  • /src/data : les fichiers JSON de données à injecter dans les gabarits HTML ou autres
  • /src/docs : l'ensemble de la documentation statique du projet au format Markdown

À chaque fois que le projet est « construit », le résultat est disponible dans les répertoires suivant :

  • /build
  • /build/doc : toute la documentation du projet au format HTML

Tâches normalisées

Tout projet démarré avec ce starter kit dispose d'un certain nombre de tâches Gulp normalisées, utilisables quels que soient les modules Gulp utilisés.

live : Permet de démarrer un serveur statique pour les pages HTML et d'avoir un watch sur les fichiers du projet en même temps.

ATTENTION : Même si tous les chemins sont résolus de manière relative, il est vivement conseillé de préférer cette méthode à tout autre serveur local que vous pourriez utiliser. De cette manière, vous verrez toujours votre site « à la racine ». Votre site répondra sur l’URL : http://localhost:8000

$ gulp live

# Pour ne pas être embêté par les tests,
# vous pouvez lancer le live en mode relax
# (Mais c'est mal et vous le savez)
$ gulp live --relax

build : Contruit la version statique du projet (compile les fichiers Sass, assemble les fichiers HTML, etc.)

$ gulp build

# Pour créer un build optimisé pour la prod
# (Fichiers minifiés, pas de doc, etc)
$ gulp build --optimize

css : construit les feuilles de styles

$ gulp css

html : construit les pages HTML statiques

$ gulp html

js : construit les fichiers JS

$ gulp js

assets : déplace et optimise les ressources statiques du projet

$ gulp assets

doc : génère la documentation du projet

$ gulp doc

test : exécute tous les tests du projet

$ gulp test

Outils utilisés

Les outils listés ici doivent êtres utilisés obligatoirement lorsqu'on démarre un nouveau projet d'intégration. Ils garantissent un workflow de travail optimal.

Les outils listés ci-après sont à utiliser et à configurer pour votre projet. Ils sont tous utilisables tel quel, mais le starter kit est suffisamment flexible pour s'adapter à vos besoins. Le choix d'utilisation de ces outils se fait via le fichier .gsk/config.json, voir les instructions de configuration ci-après :

CSS

HTML

JavaScript

Documentation