start documentation Starterkit

docs/README.md

@@ -1,5 +1,6 @@
-##Sommaire
+#Sommaire
 
+* [Starter Kit] (guides/StarterKit.md)
 * [Intro] (guides/Introduction.md)
 * [React] (guides/React.md)
 * [Routes] (guides/Routes.md)

docs/guides/Routes.md

@@ -3,31 +3,30 @@
 La configuration des routes permet de dire au routeur comment faire le lien entre l'url demandé et le code a exécuter
 dans le cas de React :
 
-import React from 'react'
-import ReactDOM from 'react-dom'
-import routes from './config/routes.jsx'
-import {Router, browserHistory} from 'react-router'
+    import React from 'react'
+    import ReactDOM from 'react-dom'
+    import routes from './config/routes.jsx'
+    import {Router, browserHistory} from 'react-router'
 
-ReactDOM.render(<Router history={browserHistory} routes={routes} />,
-root);
+    ReactDOM.render(<Router history={browserHistory} routes={routes} />,
+    root);
 
 initialise le router avec deux props history et routes :
  * history il peut y en avoir 3 types :
   * [browserHistory] (https://github.com/reactjs/react-router/blob/master/docs/guides/Histories.md#browserhistory) est celui recommandé d'aprés la doc officielle pour les applications sur navigateurs
   * [hashHistory] (https://github.com/reactjs/react-router/blob/master/docs/guides/Histories.md#hashhistory)
   * [createMemoryHistory] (https://github.com/reactjs/react-router/blob/master/docs/guides/Histories.md#creatememoryhistory)
 
-* routes la configuration des routes 
+* routes la configuration des routes
 
-
-    const routes = {
-     path: '/',
-     component: App,
-     indexRoute: { component: Vignettes },
-     childRoutes: [
-       { path: 'infos/:origin', component: GenGrille },
-       { path: 'infos/:origin/:id' , component : Details },
-       { path: '\*' , component : NotFound }
-     ]
-    }
-    module.exports = routes;
+      const routes = {
+         path: '/',
+         component: App,
+         indexRoute: { component: Vignettes },
+         childRoutes: [
+           { path: 'infos/:origin', component: GenGrille },
+           { path: 'infos/:origin/:id' , component : Details },
+           { path: '\*' , component : NotFound }
+         ]
+      }
+      module.exports = routes;

docs/guides/StarterKit.md

@@ -0,0 +1,30 @@
+# Prérequis
+Avoir nodejs d'installé et npm
+
+# La différence entre la théorie et la pratique, c'est qu'en théorie, il n'y a pas de différence, mais en pratique, il y en a une.
+
+Mon invite de commande est Cmder et l'os est windows donc adaptez-vous si besoin est :)
+
+ Créez le dossier de votre futur super projet et allez dans ce dossier
+
+    mkdir superProjet
+    cd superProjet
+
+
+On va maintenant initialiser la gestion des modules pour le projet tapez
+
+    npm init
+
+Si vous n'êtes pas familier avec npm appuyez sur la touche entrée à chaque question
+Cette commande crée un fichier <span style="color:red">package.json</span> dans votre dossier qui contiendra entre autre une <span style="color:blue">LISTE</span> des modules que vous aurez sauvegardé au fur et à mesure de vos besoins.
+
+On va donc de ce pas sauvegarder nos premiers modules indispensables pour un projet React
+
+
+      npm instal --save react react-dom
+
+Cette commande a deux effets:
+* install qui va créer un dossier node_modules qui contiendra les sources des modules
+* --save qui va sauvegarder dans le fichier packages.json les deux modules et surtout leur versions
+
+Arrivé à ce point on serait presque bon pour se lancer dans une magnifique programmation modulaire efficace intuitive etc.  mais il reste une étape primordiale il nous faut un programme pour "compiler" tout ces modules et nous fournir un joli fichier tout propre contenant notre code.