Clever Garden Starter Kit

Ce dépôt 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.

Initialisez 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

NOTE : Si la branche master existe déjà et/ou est protégée, il faut faire le git push sur une autre branche (git push -u origin gsk) puis faire une « pull request »

Configurer le GSK

À l’initialisation du projet vous devez choisir quels outils vont être utilisés pour builder le html et le css selon les besoins du projet.

Les outils listés ci-après sont à configurer via le fichier .gsk/config.json. Si vous n’utilisez que les choix recommandés, ils sont déjà configurés par défaut.

Voir les instructions de configuration ci-après :

CSS

• Sass [Recommandé]
• Sass/Compass
• Stylus
• LESS
• Si vous ne choisissez pas de préprocesseur, le projet n’utilisera que PostCss

HTML

• Twig [Recommandé]
• Handlebars

JavaScript

• Webpack + NPM [Recommandé]

Finalisation

Une fois les étapes précédentes exécutées, vous n’êtes déjà plus sur le GSK mais dans votre nouveau projet.

1. Remplacez votre readme.md par le readme.dist.md.

2. Dans celui-ci, remplacez PROJECT_NAME par le nom de votre projet et GIT_REPO_URL par l’url de son dépôt git.

3. Changez dans le package.json toutes les entrées suivantes :

   "name": "garden-starterkit",
   "homepage": "https://github.com/cleverage/garden-starter-kit",
   "title": "Garden Starter Kit",
   "description": "Set de base pour les projets Garden statiques.",
   "version": "2.0.0-beta9",
   "license" : "MIT",
   "repository": {
   "type": "git",
   "url": "https://github.com/cleverage/garden-starter-kit.git"
   },

4. Changez ou supprimez le fichier LICENSE.

Bravo !! Votre projet est en route.

Pour aller plus loin

Vous pouvez supprimer les dépendances inutiles à votre projet comme Less si vous utilisez Sass.