🎉 (configuration,formation,organisation) Premier commit

larueli · larueli · commit f9ebff2e3b91 · 2020-09-15T00:21:06.000+02:00
diff --git a/.czrc b/.czrc
@@ -0,0 +1 @@
+{ "path": "cz-emoji" }
diff --git a/1. Configuration/PHP/README.md b/1. Configuration/PHP/README.md
@@ -0,0 +1,54 @@
+# Configurer PHP sur son poste
+
+## Installer mariadb
+
+* Sous Linux, installer le paquet `mariadb`
+* Sous Windows, aller sur [ce site](https://downloads.mariadb.org/) et installer la version 10.5 stable, et le fichier winx64.msi.
+    * Cochez bien lors de l'installation `Modify root password` et notez le mdp créé (faites en un simple avec juste des chiffres et des lettres, il ne servira que sur votre poste). Déochez bien enable root access from remotes machines.
+    * Cochez bien `Install as Service` et `Enable networking`
+
+## Installer PHP
+
+* Sur Linux : `sudo apt install php7.4 php7.4-pdo_mysql php7.4-mbstring`
+* Sur Windows, cela se fait en plusieurs opérations.
+    * Aller sur le [site suivant](https://windows.php.net/download), télécharger le zip (x64 non thread safe), et l'extraire dans un dossier à la racine de votre disque dur (par exemple `C:\dev-tools\php`). Vous devez donc avoir, à terme un fichier `php.exe` dans le dossier `C:\dev-tools\php`.
+    * Téléchargez le [fichier suivant](https://curl.haxx.se/ca/cacert.pem) et placez le dans le même dossier que le php.exe
+    * Dans ce dossier, vous devez copier le `php.ini-development` en `php.ini` (faites bien une copie afin de garder le fichier d'origine en cas de souci), puis ouvrez le avec VSCode (clic-droit, Ouvrir avec code) et changez les lignes suivantes :
+    ```
+    ;  Remplacer
+    ;curl.cainfo =
+    ;  par (sans le point virgule)
+    curl.cainfo = "C:\dev-tools\php\cacert.pem"
+
+    ;  Remplacer
+    ;openssl.capath =
+    ;  par (sans le point virgule)
+    openssl.capath = "C:\dev-tools\php\cacert.pem"
+    ```
+    * Toujours dans le php.ini, recherchez `Dynamic Extensions`, puis décommentez (enlevez le `;`) des lignes suivantes :
+    ```
+    extension=curl
+    extension=fileinfo
+    extension=mbstring
+    extension=pdo_mysql
+    ```
+    * Il faut ensuite, dans la barre des tâches, rechercher `path` et ouvrir `Modifier les variables d'environnement`, puis recliquez sur le bouton du bas `Variables d'environnement` puis dans `Variables systèmes`, double cliquer sur la variable `Path` puis cliquer sur `Nouveau` et indiquer `C:\dev-tools\php\` en ajoutant bien le `\` à la fin. Puis valider la saisie en appuyant sur entrée puis en cliquant sur ok.
+
+## Installer composer
+* Sous linux : avec votre gestionnaire de paquet : `sudo apt install composer`
+* Sous Windows en utilisant [l'installateur prévu à cet effet](https://getcomposer.org/Composer-Setup.exe).
+
+## Installer l'exécutable Symfony
+* Linux : `wget https://get.symfony.com/cli/installer -O - | bash && sudo mv symfony /usr/bin/symfony`
+* Windows : allez sur le [site de Symfony](https://symfony.com/download) pour télécharger l'installateur.
+
+## Installer PHPStorm
+
+Etape finale !
+
+PHPStorm est un des meilleurs (si ce n'est pas le meilleur) IDE pour développer en PHP.
+
+* Se connecter à Jetbrains avec le Github Student Pack [ici](https://www.jetbrains.com/shop/eform/students), vous devrez ensuite vous créer un compte.
+* Téléchargez ensuite la [Jetbrains Toolbox](https://www.jetbrains.com/toolbox-app/)
+* Depuis la JetBrains Toolbox, installez ensuite PHPStorm
+* Au premier lancement, Jetbrains va vous demander plusieurs choses, notamment les plugins. Installez bien le plugin Symfony.
diff --git a/1. Configuration/README.md b/1. Configuration/README.md
@@ -0,0 +1,40 @@
+# Configuration
+
+Ce dossier contient des instructions afin de préparer ton poste. De manière générale, il est recommandé d'utiliser Linux, la configuration est beaucoup plus simple. Mais sous Windows, ça marche très bien aussi en suivant les étapes indiquées apèrs !
+
+## Créez-vous un compte Github
+
+Vous êtes dessus, cliquez sur `Sign Up` en haut à droite.
+
+Activez le [Github Student Pack](https://education.github.com/pack) en cliquant sur le bouton "Get your pack" et en fournissant votre mail universitaire (UTT, ...)
+
+## Configuration commune à tous les projets
+
+### Installer VSCode
+
+Visual Studio Code est un éditeur de texte brut. Il est très pratique pour éditer rapidement un fichier de configuration. Vous êtes bien entendu libre d'utiliser autre chose (Notepad++, Vim, ...) mais n'utilisez **jamais** Office ou LibreOffice pour éditer un fichier, ils n'éditent pas de manière *brute* les fichiers, ils ajoutent des informations supplémentaires (mise en forme, ...) qui rendent ces fichiers inutilisables dans notre contexte.
+
+Allez sur [le site de VSCode](https://code.visualstudio.com/), téléchargez et installez la version correspondant à votre PC.
+* Pour Windows, laissez toutes les options par défaut mais pensez à cocher toutes les cases du genre `Ajouter VSCode au menu contextuel`
+* Pour Linux, vscode n'est pas directement accessible dans les repos traditionnels, il faut donc le télécharger et l'installer via votre gestionnaire de paquets (afin d'ajouter aussi le repo dans la liste de vos sources pour les mises à jour), par exemple `sudo apt install ./vscode.deb`.
+
+### Installer git
+
+C'est un outil qui va te permettre de télécharger et d'envoyer du code source.
+
+* Sur windows, il faut se rendre sur [ce site](https://gitforwindows.org/), cliquer sur download. Vous arrivez sur la page des releases du projet Github correspondant. Plus bas, dans assets, téléchargez le fichier exe en 64bits puis installez le sur votre poste, en **laissant les options par défaut**.
+* Sur Linux, c'est beaucoup plus facile. Installez le paquet `git` avec votre gestionnaire de paquets (exemple : `sudo apt install git`).
+
+### Installer commitizen
+
+C'est un outil qui va te permettre d'expliquer aux autres collaborateurs ce que tu as changé sur le code quand tu as fait une modification de manière standard.
+
+Il faut d'abord installer node.
+* Sous Windows, il faut aller sur [ce site](https://nodejs.org/en/), télécharger la version current et installer en laissant les options standards.
+* Sous Linux, avec le gestionnaire de paquet, installer `npm`, soit par exemple `sudo apt install npm`
+
+Ensuite il faut installer commitizen, pour cela, ouvrez un terminal et saisissez : `npm install -g commitizen` puis `npm install -g cz-conventional-changelog` puis `npm install -g cz-emoji`.
+
+## Configuration spécifique à PHP
+
+Aller dans le dossier PHP
diff --git a/2. Formation/README.md b/2. Formation/README.md
@@ -0,0 +1,20 @@
+# Git
+
+* https://learngitbranching.js.org/?locale=fr_FR
+* https://try.github.io/
+* Pour ceux qui adorent lire des pavés, le livre Git Pro est vraiment bien :
+    * En [pdf](https://github.com/progit/progit2-fr/releases/download/2.1.48/progit_v2.1.48.pdf)
+    * En [version web](https://git-scm.com/book/fr/v2)
+    * Lire les chapitres 1, 2, 3 et 6.
+
+# Back
+
+* [Introduction aux API](https://la-cascade.io/api-une-introduction/)
+* Symfony : [6 étapes pour comprendre comment Symfony fonctionne](https://symfony.com/doc/current/setup.html)
+
+# Front
+
+* React :
+    * Le [tutoriel](https://fr.reactjs.org/tutorial/tutorial.html)
+    * La [doc](https://fr.reactjs.org/docs/getting-started.html)
+* Flexbox : http://flexboxfroggy.com/#fr
diff --git a/3. Organisation/CONTRIBUTE.md b/3. Organisation/CONTRIBUTE.md
@@ -0,0 +1,80 @@
+# 💻 Contribute
+
+## 📦 Develop a feature
+
+### 1. ✨ Start a feature branch:
+
+be sure to start from `develop` branch :
+
+```bash
+$ git checkout dev
+```
+
+Than, create the branch :
+
+```bash
+$ git checkout -b "feature/name-of-the-feature"
+```
+
+### 2. 💻 Start working on your feature
+
+Code, create files, ...
+
+### 3. Commit
+
+Every time you do a small thing for your feature, COMMIT. It is very important you break your code in small parts. It would be easier to review it.
+
+First, select the files you want to add to the commit :
+
+```bash
+$ git add name_of_the_file
+```
+
+Or easier : go to the git tab in VSCode. You can find it on the left of the editor, just after the loop. You will see all the modified files, with a + next to them when you hover them. Click on + to add the file in the commit.
+
+To commit, use :
+
+```bash
+$ git cz
+```
+
+This will ask you some questions :
+
+- type of commit : is it a feature, some doc, tests,...
+- what file or what's globally inside the commit
+- a small description of the commit
+
+The 3 first question will determine the title of the commit
+
+- a longer description of the commit (optional)
+- other question you do not have to answer them, just press enter
+
+You now have committed your work!
+
+### 4. 👀 Code Review
+
+1. Rebase your feature branch onto the `develop` branch to ensure it is up-to-date (in case someone did something while you did yours)
+
+   ```bash
+   $ git pull --rebase origin dev
+   ```
+
+2. Push the code to github :
+
+   ```bash
+   $ git push
+   ```
+
+3. When pushing, git will give you a like to create a pull request. Create one
+
+4. Ask for a thorough Code Review by a Code Owner
+
+### 5. 📦 Merge your feature back into the `develop` branch
+
+Only when validated by the code owner. This will start the deployment on develop (TODO)
+
+### 6. 📱 Test & validate your feature on the develop website
+
+Go to [develop website](https://dev.etu.uttnetgroup.fr). Your feature will be applied on it when the deployment is finished. A message will be sent on slack when the deployment is over (TODO)
+
+## Go back to [README](./README.md)
diff --git a/3. Organisation/README.md b/3. Organisation/README.md
@@ -0,0 +1 @@
+# Organisation
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Le site etu
+
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+Vous voulez faire du dev pour le site etu, mais vous ne savez pas par où commencer ? **Vous êtes au bon endroit !**
+
+## Au secours ! Pour moi, PHP, Git, React, c'est du chinois !
+
+Pas de panique. Commence par configurer ton poste (`1. Formation`) puis va dans le dossier `2. Formation` !
+
+## Je connais déjà un peu (ou j'ai suivi le dossier formation)
+
+Va dans le dossier `1. Configuration` pour configurer ton poste puis dans le dossier `3. Organisation` pour comprendre comment le projet est fait.
+
+## Autre
+
+* Le dossier `Repo` contient des indications pour créer un repository.
diff --git a/Repo/LICENCE.md b/Repo/LICENCE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 UTT NET GROUP
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Repo/README.md b/Repo/README.md
@@ -0,0 +1,43 @@
+# Ajouter un repo
+
+Imaginons que nous devions ajouter une API, ou un nouveau repo de manière générale. Voici les étapes et conventions à suivre.
+
+## Nommage, stockage et accès
+
+* Le nom du repo et du projet sera sous la forme suivante : `etuutt-service`, en **minuscule**.
+* Le repo est créé dans github, sur l'organisation `ungdev`. Le repo doit être créé complètement vide.
+* Au niveau des droits d'accès au repo, il y a plusieurs équipes. Selon votre projet, il faudra en créer une ou incorporer les droits d'une équipe existante. L'équipe d'amdin (`etuutt-admin`) vous indiquera s'il faut créer une équipe et quelle équipe il faudra créer le cas échéant. S'il doit y avoir une nouvelle équipe spécifique à votre projet, celle-ci doit impérativement porter le nom `etuutt-service` et avoir comme équipe parente `etuutt`.
+* Les droits sont les suivants :
+    * L'équipe `etuutt` a les droits `Triage`.
+    * Votre équipe ou une équipe déjà existante, rattachée au projet, a les droits `Maintain`.
+    * L'équipe `etuutt-admin` a les droits `Admin`.
+
+## Convention communes aux repos
+
+* Utilisation de [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). Le mieux est d'utiliser [commitizen](https://github.com/commitizen/cz-cli#conventional-commit-messages-as-a-global-utility) en l'installant sur son poste (indépendant du projet). Dans le dossier du projet, taper la commande `echo '{ "path": "cz-emoji" }' > .czrc` afin de définir l'adaptateur pour le projet.
+* Le projet est sous [licence MIT](https://choosealicense.com/licenses/mit/), attribué à `UTT NET GROUP`.
+* Un dossier `docs` est à la racine. Le dossier docs de la branche master est utilisé pour Github Pages.
+* Deux branches : `prod` et `dev`. La branche par défaut est `dev`.
+
+* Pour du back, on utilise PHP/Symfony
+* Le front est en React
+
+## Appli PHP
+
+* `symfony new etuutt-service --full`
+* `cd etuutt-service`
+* `git branch -m master prod`
+* `echo 7.4 > .php-version`
+* Installation d'outils de dev supplémentaires
+```
+composer require --dev phpmd/phpmd
+composer require --dev friendsofphp/php-cs-fixer
+composer require --dev doctrine/doctrine-fixtures-bundle
+composer require --dev squizlabs/php_codesniffer
+```
+
+Vous devez copier le `.php_cs.dist` et le `.travis.yml` du dossier php et le mettre à la racine de votre projet.
+
+
+
+
diff --git a/Repo/deploy_licence.sh b/Repo/deploy_licence.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+cp LICENCE.md ../../etuutt-files/
+cp LICENCE.md ../../etuutt-api/
+cp LICENCE.md ../../etuutt-gateway/
diff --git a/Repo/php/.php_cs.dist b/Repo/php/.php_cs.dist
@@ -0,0 +1,22 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->exclude('var')
+    ->exclude('vendor')
+;
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@DoctrineAnnotation' => true,
+        '@PhpCsFixer' => true,
+        '@PhpCsFixer:risky' => true,
+        '@PSR1' => true,
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder)
+;
diff --git a/Repo/php/.travis.yml b/Repo/php/.travis.yml
@@ -0,0 +1,22 @@
+os: linux
+dist: xenial
+
+language: php
+php:
+  - 7.4
+
+cache:
+    directories:
+        - vendor
+
+install:
+  - composer install
+
+jobs:
+  include:
+    - stage: test
+      name: PHP CS Fixer
+      script:
+        - CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRTUXB "${TRAVIS_COMMIT_RANGE}")
+        - if ! echo "${CHANGED_FILES}" | grep -qE "^(\\.php_cs(\\.dist)?|composer\\.lock)$"; then EXTRA_ARGS=$(printf -- '--path-mode=intersection\n--\n%s' "${CHANGED_FILES}"); else EXTRA_ARGS=''; fi
+        - php vendor/bin/php-cs-fixer fix --config=.php_cs.dist -v --dry-run --stop-on-violation --using-cache=no ${EXTRA_ARGS}
diff --git a/Repo/php/deploy_php_cs_dist.sh b/Repo/php/deploy_php_cs_dist.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+cp .php_cs.dist ../../../etuutt-files/
+cp .php_cs.dist ../../../etuutt-api/
+cp .php_cs.dist ../../../etuutt-gateway/
diff --git a/Repo/php/deploy_travis_yml.sh b/Repo/php/deploy_travis_yml.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+cp .travis.yml ../../../etuutt-files/
+cp .travis.yml ../../../etuutt-api/
+cp .travis.yml ../../../etuutt-gateway/
