Commencer un nouveau projet

Après avoir récupéré les sources de Scampi-Twig par clone, fork ou téléchargement selon vos besoins, il restera deux petites étapes avant de commencer à l'utiliser :

Renseigner les informations du nouveau projet

Dans le fichier package.json, ajuster le nom, la version et l’url du dépôt ainsi que la licence et les auteurs.

Dans le fichier config.json, renseigner les informations du site (nom et description) et ajuster si nécessaire les autres informations.

Installer les dépendances

Lancer la commande :

$ npm install

Ou, si yarn est installé sur votre ordinateur et que vous préférez l'utiliser :

$ yarn

Note aux utilisateurs de Windows

Selon votre version de Node, il est possible qu'au premier npm install la console tousse et renvoie des messages informant que l'installation n'a pas pu se faire en raison d'un node-sass incompatible. Cela peut aisément être résolu en faisant un :

$ npm install node-sass@latest

puis en relançant le

$ npm install

Et hop !

On peut alors lancer l'index du projet dans le navigateur et commencer à développer :

$ gulp dev

Voir toutes les tâches Gulp disponibles.

Étapes suivantes

La méthodologie que nous suivons et que nous recommandons est de commencer par les étapes suivantes :

  1. Vérifier (et éventuellement compléter) les informations de l'index du projet
  2. Commencer par établir les bases de style depuis le styleguide.

Les informations données dans cette rubrique correspondent à la version 1.0 release candidate de Scampi-Twig, encore en développement. Pour lire la documentation de la version courante (0.3.1), référez-vous au readme du dépôt.