STIC:STIC I - Atelier technique 1

De EduTech Wiki
Aller à : navigation, rechercher

Cette page fait partie des cours STIC I et STIC II

STIC


1 Programme

Au programme (peut changer) :

  • Introduction du projet Webmaster (évalué dans le cadre du cours STIC II)
  • Ligne de commande
  • Git/GitHub
  • Permission fichier sur serveur distant (s'il reste du temps)

2 Projet Webmaster

Pour toute information voir :

En bref :

  • Travail qui sera évalué dans le cadre de l'ex16 du cours STIC II (fin de la première année)
  • Ce n'est pas un projet comme dans le sens des cours ERGO II, VIP II, ...
  • Types de projets possibles :
    1. Default : Installation et configuration d'un portail web (e.g. Word_press, Moodle, Mediawiki)
    2. Alternatif : Développement d'un site/application full stack (front-end + back-end) avec JavaScript (voir Node.js, Express.js, Socket.io)
    3. D'autres projets peuvent être envisagées (e.g. logiciel desktop avec Electron, Internet/Web of things, etc.). Vous pouvez nous soumettre votre idée de projet.

Les ateliers techniques vous proposent des techniques/outils pour mener à bien ce(s) projet(s).

2.1 Tâche pour le prochain Atelier

Réfléchir sur une idée de projet à développer pour le projet Webmaster. Pour inspiration voir les projets des étudiants des autres volées :

  • Exercice 16 volée Wall-e
  • Exercice 14 ou Projet Webmaster pour les volées précédentes

Attention : pour des raisons de sécurité les projets webmaster des étudiants sont accessibles seulement sur le réseau de l'UNIGE ou via VPN

3 Ligne de commande

Pourquoi ?

  • Faire certaines opérations pas possibles avec une interface GUI
  • Comprendre les scripts, c.f. fichier de commande
  • Faire des opérations sur un serveur distant (notamment pour installer des portails)

3.1 Logiciel

Utilisation d'un logiciel pour accéder à la ligne de commande. Attention : l'utilisation de la ligne de commande peut générer des opérations irréversibles !

Logiciels :

  • Pour Windows utiliser Windows PowerShell en local et PuTTY pour le serveur distant
  • Pour Mac utiliser le Terminal
  • Pour Linux utiliser l’une des lignes de commandes disponibles selon la version.

Les commandes que nous allons voir par la suite fonctionnent sur toutes les plateformes, mais ce n'est pas toujours le cas, et même parmi les commandes illustrés par la suite il y a des différences entre Windows vs. Mac/Linux.

3.2 Position actuelle

Lorsque vous utilisez la ligne de commande, faites toujours attention à la position actuelle dans le système, que ce soit en local ou sur un serveur distant.

Toujours bien vérifier la position actuelle (i.e. le path) lorsqu'on utilise la ligne de commande.

Pour récupérer votre position actuelle si elle n'est pas visible, utilisez :

pwd

C'est l'acronyme de "Print Working Directory".

3.3 Commandes principales

Il y a eu un effort dans les dernières années pour uniformer certaines commandes dans les différentes plateforme (Win vs. Unix). Les commandes listées par la suite fonctionnent généralement sur tous les systèmes :

Changer de dossier
cd

C'est l'acronyme de Change Directory. On utilise cette commande avec des chemins absolus ou relatifs à la position actuelle.

Vous pouvez faire référence aux différents niveaux de l'arborescence par rapport à la position actuelle avec les notations suivantes :

  • ./ fait référence au dossier actuel
    • attention à ne pas confondre avec / (sans point) qui fait référence à la racine de votre système où se trouvent des fichiers importants !
  • ../ fait référence à un niveau supérieur
  • ../../ fait référence à deux niveaux supérieurs
  • etc.
  • ~ fait référence au dossier utilisateur (dont la position peut varier selon le système d'exploitation).

Examples :

  • cd documents
  • cd ../stic-1/ex1/
  • cd ~/Documents
  • cd /home

Hint:

  • vous pouvez vous aider avec la touche TAB pour complèter des noms des fichiers très longs. Cette pratique s'applique à toutes les commandes
  • vous pouvez trainer un dossier depuis votre gestionnaire de fichiers dans le terminal de commande pour faire apparaître son chemin
  • pour windows seulement : quand vous êtes au bon chemin dans votre gestionnaire de fichiers appuyez sur les touches Ctrl + l (comme lausanne) et tapez powershell dans la barre de l'adresse.
Lister les fichiers
ls

On utilise cette commande pour afficher une liste de dossiers/fichiers existants à un chemin donné. Si la commande n'a pas d'argument, la position actuelle sera prise en compte. Si non, il est possible de fournir :

  • Un chemin absolu ou relatif, e.g. ls /home va lister tous les éléments contenu dans le dossier home qui se trouve à la racine du système
  • Un critère de selection, e.g. ls *.png va lister tous les fichiers qui terminent avec .png
Créer un dossier
mkdir nom-du-dossier

C'est l'acronyme de Make Directory. On utilise cette commande pour créer un nouveau dossier à un chemin donné (dans la position actuelle si on spécifie juste le nom du nouveau dossier).

Examples :

  • mkdir my-new-folder
  • mkdir ~/Documents/atelier-webmaster
Copier un fichier/dossier
cp chemin-du-fichier-existant chemin-de-la-nouvelle-copie

On utilise cette commande pour créer une copie d'un fichier existant et la placer dans un autre endroit.

Examples :

  • cp documents documents-old
  • cp file.txt /home/backup/file.txt
Déplacer un fichier/dossier
mv chemin-du-fichier-actuel nouveau-chemin-du-fichier

On utilise cette commande d'une manière similaire à cp avec la différence que le fichier lui-même sera déplacé à un nouveau endroit.

Examples :

  • mv stic-1/ex12/ stic-2/ex12/
Détruire des fichiers/dossiers

Il existe des commandes également pour détruire des fichiers/dossiers mais on les verra pas ici. Ces commandes sont en effet irreversibles (i.e. les fichiers ne sont pas mis dans la corbeille).

3.4 Travailler avec un serveur linux distant

4 Git/GitHub

Git (logiciel de gestion de version en local) et GitHub (extension online de Git) sont des outils qui sont très utilisés à présent et leur connaissance, au moins au niveau de base, peut être utile à plusieurs niveaux. En effet, ils ne sont pas utilisés exclusivement pour la programmation, mais également pour :

  • Maintenir un site web
  • Écrire/maintenir de la documentation online
  • Écrire des livres
  • Mettre à disposition du matériel d'un cours (online)
  • Créer une classe virtuelle avec des devoirs qui prévoient du codage
  • Découvrir des projets existants et créer des liens avec d'autres personnes actives dans les projets
  • ...

En plus, la participation dans des projets open-source disponibles sur GitHub ne se limite pas à l'écriture du code. Les projets recherchent souvent d'autres type de participation tels que :

  • La gestion du projet
  • Collecter/répondre aux "Issues" soulevées par les utilisateurs
  • Tester/débugger les projets
  • Corriger l'orthographe
  • ...

4.1 Présentation

Git et GitHub dans un projet open-source
À retenir 
  • Git = système de version de fichiers en local. Vous pouvez travailler sur plusieurs versions de votre projets :
    • Créer des "branches" pour tester des nouvelles fonctionnalités
    • Revenir à une version précédente si quelque chose ne marche pas correctement
    • ...
  • GitHub = plateform de développement collaborative pour projets
    • Vous pouvez travailler à plusieurs sur le même projet/repository
    • Les projets peuvent être publics (default) ou privés (versions payante)
    • Les projets peuvent être open-source ou pas
    • Attention à ne pas confondre public = open-source et privé = non open-source, c'est la licence qui détermine le type de projet
À savoir 
  • On peut utiliser Git sans GitHub, mais c'est difficile de pouvoir utiliser GitHub sans Git (quoi que possible si on travail juste avec l'interface du site)
  • On peut utiliser Git avec d'autres services online, e.g. :
  • On peut utiliser Git et GitHub avec n'importe quel type de projet/fichier (pas que développement web)
À éviter 
  • Évitez de créer des projets/repository Git dans de dossiers locaux qui sont liés à un système de synchronisation de données (e.g. Dropbox, OneDrive, Google Drive)
  • Faites attention à ne pas publier des données sensibles. Par exemple si vous publiez par erreur un mot de passe, pensez à le modifier tout de suite, il ne suffit pas de le faire disparaître de GitHub (entretemps quelqu'un peut l'avoir vu ou il peut rester dans la cache, etc.) - voir Removing sensitive data from a repository

4.2 Installation des logiciels

4.2.1 Git

  1. Installez le logiciel git depuis le site officiel : https://git-scm.com/
  2. Il faudra configurer Git à travers la ligne de commande
    • Attention : utilisez le nom d'utilisateur et l'adresse email que vous avez utilisé pour créer votre account GitHub
Nom d'utilisateur
git config --global user.name "votre username GitHub"
Email
git config --global user.email votre-email-account-github@domain.com

Ces configurations vont permettre par la suite de reconnaître vos contributions, par exemple dans un projet commun.

4.2.2 Optionnel : Git dans éditeur de texte

Il y a la possibilité d'ingérer git directement dans des éditeurs de texte, par exemple :

4.2.3 GitHub

  1. Créer un account sur le site https://github.com/ si pas fait lors de l'atelier MINIT

4.2.4 GitHub Desktop

  1. Installez GitHub Desktop https://desktop.github.com/

Documentation logiciel : https://help.github.com/desktop/guides/

4.3 Activités prévues

4.3.1 Tutoriel interactif

Bon tutoriel initial disponible directement dans le navigateur sur le site de GitHub. Suivre toutes les étapes :

4.3.2 Création d'un projet sur GitHub et le cloner avec GitHub Desktop

Créer un répositoire sur GitHub.com qui simule un projet public/open-source, cela permet de voir :

  • Utilisation du site GitHub.com
  • Utilisation de GitHub pour Desktop

Pour plus d'info voir

Première étape - Créer le projet sur GitHub.com

Suivre les étapes suivantes :

  1. Sur le site GitHub.com, lorsque vous avez fait le login, cliquez sur le + et choisissez New repository
  2. Saisissez les données requises (à vous de choisir des informations saillantes pour un potentiel projet open-source) en faisant attention à :
    • Cochez l'option Initialize this repository with a README
    • Choisir une option dans le menu déroulant Add a license (voir une page qui vous aide à choisir, si non vous pouvez mettre MIT pour cet exemple)
      Création d'un projet avec README et Licence
  3. Cliquez sur Create repository, vous êtes redirigés sur la page de votre projet qui doit ressembler à celle-ci :
    Page d'un projet créé à travers le site GitHub.com

Si vous cliquez sur le fichier LICENSE vous pouvez voir les détails des droits que vous avez spécifié pour votre projets.

Deuxième étape - Cloner le projet sur votre ordinateur avec GitHub Desktop

Suivre les étapes suivantes :

  1. Ouvrez le logiciel GitHub Desktop
  2. Si vous l'ouvrez pour la première fois, il vous faudra vous loguer et confirmer les informations pour Git (Nom et Email)
  3. Ensuite cliquez sur le bouton Clone a repository ou faites File > Clone repository... si vous ne l'avez pas
  4. Choisissez le projet que vous venez de créer, décidez à quel endroit le mettre sur votre ordinateur et cliquez sur Clone
    Cloner un projet en local avec GitHub Desktop
  5. Ouvrez le dossier en local avec votre Gestionnaire de fichiers, vous devez voir :
    • Un dossier caché qui s'appelle .git (si vous ne le voyez pas cherchez sur internet comment afficher les fichiers cachés dans votre ordinateur)
    • Le fichier LICENSE
    • Le fichier README.md
  6. Créez un fichier quelconque à l'intérieur de ce dossier (par exemple un fichier qui s'appelle first-contribution.txt)
  7. Revenez dans GitHub Desktop, le fichier que vous venez d'ajouter doit figurer dans l'onglet Changes. Il faudra à ce moment faire un commit pour incorporer ce nouveau fichier dans votre projet
    1. Insérez un summary de votre commit, par exemple Added my first file
    2. Insérez une description (optionnelle) qui permet de mieux comprendre en quoi consiste le changement
    3. Cliquez sur Commit do master
      Commit avec GitHub Desktop
  8. Enfin, cliquez sur Push origin pour envoyer les changements à GitHub
    Push origin permet d'envoyer les changements au repository de GitHub
  9. Contrôlez sur la page du projet sur GitHub.com que le nouveau fichier apparaît dans le projet

4.3.3 Participer à un projet déjà existant

Petit hands-on sur comment on peut participer/contribuer à un projet déjà existant. En bref :

Pour plus d'infos voir

Suivre les étapes suivantes 
  1. Pointer à l'URL d'un repository/projet créé pour l'occasion https://github.com/MALTT-STIC/stic-webmaster-test-xerneas
  2. Cliquez sur le bouton Fork en haut à gauche, cette opération vous permet de créer une copie du projet dans votre account
  3. Après le temps nécessaire, vous serez redirigés vers la page du fork du projet
    • Notez bien le nom du projet maintenant, il s'appelle votre-login-github/stic-webmaster-test-xerneas
    • Notez également que au-dessous du nom du projet apparaît forked from MALTT-STIC/stic-webmaster-test-xerneas
  4. Cliquez sur le bouton Create new file
  5. Dans l'éditeur en ligne qui s'ouvre :
    1. Ajoutez un nom du fichier du type votre-username-github.md
    2. Ajoutez du contenu, pas important quoi (si jamais c'est du contenu de type Markdown, une notation de marquage similaire au code wiki)
    3. Insérez une labellisation à votre commit
    4. Insérez une description pour votre commit (optionnelle)
    5. Laissez l'option Commit directly to the master branch cochée
    6. Cliquez sur Commit new file
  6. Vous êtes redirigés sur la page principale de votre projet où le nouveau fichier apparaît avec les autres fichiers. Cliquez maintenant sur New pull request
  7. Vous arrivez sur une page qui compare votre projet avec le projet original et vous informe que vous pouvez merge les deux sans conflits. Cliquez sur le bouton vert Create pull request
    Créer une "Pull request" au projet d'origine
    1. Encore une fois, choisissez une labellisation qui définit votre changement
    2. Ajoutez également une explication qui permette aux propriétaires du projet originale de savoir pourquoi vous proposez ce changement
    3. Cliquez à nouveau sur le bouton vert Create pull request
      Envoyer la pull request avec une explication pour les propriétaires du projet original
  8. Votre requête sera envoyée aux propriétaires du projet original qui pourront décider si l'accepter (et l'intégrer donc dans le projet) ou pas

4.3.4 Pour aller plus loin

Il existe beaucoup de commandes qui vous permettent de travailler à différentes versions de votre projet en local, comparer les différences, faire un merge entre deux branches, etc :

  • git init
  • git add [params]
  • git commit [params]
  • git branch [params]
  • git checkout [params]
  • ...

Pour plus d'infos voir Git - Reference sur le site officiel de Git

5 Ressources

5.1 Ligne de commande

5.2 Git/GitHub

5.3 GitHub Education & Classroom

5.4 Open Source