Access Control is now enabled for Gitlab Pages so you can now restrict Pages to authorized users only. If needed, make your website publicly available : Navigate to your project's Settings > General > Visibility and select Everyone in pages section.

Commit ae81da5d authored by acknowledge's avatar acknowledge

Add English version

parent c4dc701b
Git repo template for student project
This is a template that you can use for any semester project, internship project or Bachelor/Master thesis. It contains the following files:
- a `docs/` folder that will contain useful project documents (weekly meeting minutes, specifications, presentations slides, planning, report and so on.)
- a `code/` folder that will contain your code. Two files are already there:
- `.gitignore` : list all the files that you want Git to ignore (config files, passwords, IDEs configs, libraries, and so on.). Its content will vary depending on the language/technologies you use.
- `` : explain how to use the code (prerequisites, dependencies, things to do to install and run the software)
To use it, just download this repository and create a new Git repo for your project.
If you want to improve this template, just create a [Merge Request]( or suggest improvements by opening an [Issue](
This README contains the general information about your project (that you have to fill). Delete all that is above the dotted line here below.
PS: README files formatting is done in [Markdown](
PS2: If you use this template, please give it a star (on top of the page). It'll gain visibility among the public repos of HEIA-FR.
In order to start your project in the best way possible, here is a list of the step you have to do. Tick the boxes once they're done. When all of them are ticked, you'll be ready to start!
First day
- [ ] Download this template, create a new Git repository for your project (eg "tb-super-website"), and push it all on Gitlab.
- [ ] Edit this README and delete the first part (check these first two steps by putting an "x" between the brackets, like this: [x])
- [ ] Do an introductory meeting with your supervisor
- [ ] Fill in the project metadata below (See [Project name](#project-name))
- [ ] Give access to my Gitlab repository to my supervisor(s) (in the left pane `Settings/Members`)
**Resources:** If you are not comfortable with Git, Docker or other tools, tutorials can be found on the repository[jacky.casas/basic-tutorials](, take a look.
First week
- [ ] Install the required software on your computer
- [ ] Discover/read/test the different technologies linked to the project
- [ ] Write the **specifications** of the project (template available [here](/docs/templates/CahierDesCharges-Template.docx))
- [ ] Schedule a weekly meeting with your supervisor. After each session, you will **write a meeting minute (or PV)** and put it in the project repository `/docs/PVs/`. A [LaTeX template](/docs/PVs/template/pv.tex) and a [Word template](/docs/PVs/template/PV-Template.docx) are in the same folder)
- [ ] Mettre son code dans le dossier `code/` et renseigner dans le fichier `code/` la façon d'installer et de lancer votre code (tout doit y figurer pour qu'une personne lambda puisse installer votre logiciel depuis zéro)
- [ ] Put your code in the `code/` folder and write in the `code/` file how to install and launch your code (everything must be there so that anyone can install your software from scratch)
A presentation session of the specifications will be organized around the 2nd week by your supervisor (again, a [template](/docs/templates/Presentation-Template.pptx) exists).
A final presentation will also be organized in due course.
Here you are, you're officially on board! :)
Here is a checklist to make sure you have everything pushed on Gitlab before the end of your project. If everything is checked, it should be ok.
- [ ] All the code is in the `code/` folder
- [ ] The file `code/` contains all the explanations necessary for installing and running my code
- [ ] The meeting minutes of all the sessions are in the folder `docs/PVs/`
- [ ] The specification sheet is located in the `docs/` folder
- [ ] The slides of the midterm presentation can be found in the `docs/` folder
- [ ] The final report can be found in the `docs/` folder
- [ ] The slides of the final presentation of the project are in the folder `docs/`
- [ ] A demonstration video of your project has been edited, sent to your supervisor, and uploaded to the [YouTube channel of the HumanTech Institute](
- [ ] I organized a departure apero (optional, depends on your supervisor);)
Project name
General information
- **Student/Intern**: my name -
- **Supervisor**: [Jacky Casas]( -
- **Professeur**: [Elena Mugellini]( -
- **Professeur**: [Omar Abou Khaled]( -
- **Dates**: from 01.07.2020 to 31.08.2020
This project ...
The goal of the project is to ...
This repo contain all the documentation related to the project in the `docs/` folder. The code is in the `code/` folder.
Template de dépôt Git pour projet d'étudiant
Ceci est un exemple de dépôt Git pratique qui peut être utilisé pour tout projet de semestre, projet de stage ou travail de Bachelor/Master. Il contient l'architecture de base suivante :
- un dossier `docs/` qui contiendra tous les documents utiles au projet (PVs des séances hebdomadaires, cahier des charges, présentation intermédiaire et finale, planning, rapport, etc.)
- un dossier `code/` qui contiendra, comme son nom l'indique, le code. Il contient déjà deux fichiers :
- `.gitignore` : pour y mettre tous les fichiers qui devront être ignorés par Git (fichiers de config, mots de passe, config d'IDE, librairies etc.). Il sera différent en fonction du language/framework utilisé.
- `.gitignore` : pour y mettre tous les fichiers qui devront être ignorés par Git (fichiers de config, mots de passe, config d'IDE, librairies etc.). Il sera différent en fonction du langage/framework utilisé.
- `` : devra contenir les explications pour lancer le projet (dépendances, manipulations à faire, installation, lancement)
Pour l'utiliser, téléchargez simplement ce dépôt et faites-en un dépôt Git relatif à votre projet.
......@@ -33,10 +35,10 @@ Premier jour
- [ ] Editer ce README et supprimer la première partie (cocher ces deux premières étapes en mettant un "x" entre les crochets, comme ça: [x])
- [ ] Faire une séance d'introduction avec votre superviseur
- [ ] Remplir les méta-données du projet ci-dessous (Voir [Nom du projet](#nom-du-projet))
- [ ] Donner les accès à mon dépôt Gitlab à mon/mes superviseur/s (dans le panneau à gauche `Settings/Members`)
**Ressources :** Si vous n'êtes pas à l'aise avec Git, Docker ou d'autres outils, des tutoriels se trouvent sur le dépôt [jacky.casas/basic-tutorials](, jettez-y un oeil.
{: .note}
Première semaine
......@@ -56,7 +58,7 @@ Voilà, vous êtes "onboardés" ! :)
Voici une check-list pour être sûr d'avoir tout déposé sur Gitlab avant la fin de votre projet. Si tout est coché, ça devrait être ok.
......@@ -68,7 +70,7 @@ Voici une check-list pour être sûr d'avoir tout déposé sur Gitlab avant la f
- [ ] Le rapport final se trouve dans le dossier `docs/`
- [ ] Les slides de la présentation finale du projet se trouvent dans le dossier `docs/`
- [ ] Une vidéo de démonstration de votre projet a été montée, envoyée à votre superviseur, et uploadée sur la [chaine Youtube de l'institut HumanTech](
- [ ] Avoir organisé un apéro de départ (optionnel, dépend de votre superviseur) ;)
- [ ] J'ai organisé un apéro de départ (optionnel, dépend de votre superviseur) ;)
......@@ -78,10 +80,11 @@ Nom du projet
Infos générales
- **Etudiant** : mon nom -
- **Etudiant/stagiaire** : mon nom -
- **Superviseur** : [Jacky Casas]( -
- **Professeur** : prof -
- **Dates** : du 34.12.2017 au 03.14.2018
- **Professeur** : [Elena Mugellini]( -
- **Professeur** : [Omar Abou Khaled]( -
- **Dates** : du 01.07.2020 au 31.08.2020
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment