Skip to content

Commit

Permalink
update commit to GSK v3
Browse files Browse the repository at this point in the history
  • Loading branch information
Yvain Liechti committed Aug 29, 2017
1 parent e294491 commit cce6f92
Showing 1 changed file with 19 additions and 86 deletions.
105 changes: 19 additions & 86 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,36 @@
Clever _Garden Starter Kit_
===============================================================================
# Clever _Garden Starter Kit_

Ce dépôt sert de kit de démarrage pour les projets d'intégration statique.
This project is a package of usefull gulp tasks for static project.

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.
It contains every tools for implementing our best practicesrequired in our static project at Clever Age.

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](https://daringfireball.net/projects/markdown/syntax) et est disponible dans le répertoire `docs` de ce dépôt.
Each tool has a dedicated documentation about his use in our context. This documentation is edited in [Markdown format](https://daringfireball.net/projects/markdown/syntax) and available in `docs` directory of this repository.

## Initialize your project

Créer un nouveau projet
-------------------------------------------------------------------------------
Pour créer un nouveau projet, suivez simplement les instructions ci-après.
1. Initialize git `git init` (or clone your project repository if existing yet).
2. Initialize your project with `npm init`.
3. Install the GSK `npm install cleverage/garden-starter-kit#next` (`next` is branch for v4 alpha).

> **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._
During installation, GSK will ask which html and css engines you want (Twig and Sass by default).

## Initialisez votre projet
Vous avez deux options pour démarrer votre projet :
The GSK will install required dependencies for these engines and prepare some files in your project

1. [Télécharger](https://github.com/cleverage/garden-starter-kit/archive/master.zip) 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)
⚠ You won’t be able to change these choices later.

### Clôner le kit de démarrage avec Git
Si vous le souhaitez, vous pouvez directement clôner ce dépôt avec Git.
4. You can commit your change and start your project.

Le plus simple :
## Engine choices informations

```bash
$ cd ~/monProjet
$ git clone [email protected]: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 :

```bash
$ 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 `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](docs/css/sass.md) [Recommandé]
### CSS
* [Sass](docs/css/sass.md) [Recommanded]
* [Sass/Compass](docs/css/compass.md)
* [Stylus](docs/css/stylus.md)
* [LESS](docs/css/less.md)
* Si vous ne choisissez pas de préprocesseur, le projet n’utilisera que PostCss

#### HTML
* [Twig](docs/html/twig.md) [Recommandé]
### HTML
* [Twig](docs/html/twig.md) [Recommanded]
* [Handlebars](docs/html/handlebars.md)

#### JavaScript
* [Webpack + NPM](docs/js/webpack.md) [Recommandé]

### Finalisation

Une fois les étapes précédantes executé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 :

```json
"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.

### JavaScript
* [Webpack + NPM](docs/js/webpack.md)

0 comments on commit cce6f92

Please sign in to comment.