Skip to content
Snippets Groups Projects
Commit fe3fba3b authored by abouchtita's avatar abouchtita
Browse files

Résolution du conflit sur README.md

parents 85246085 236ccff9
No related branches found
No related tags found
No related merge requests found
Pipeline #47799 failed
<<<<<<< HEAD
### **README – TP Polytech Marseille 2025 (FISA & FISE)**
**Projet Node.js avec GitLab CI, Tests et Gestion de Code**
---
## **Introduction**
Ce projet a pour objectif de vous familiariser avec :
- L’utilisation de Git et GitLab (gestion des branches, merge requests).
- L’écriture de tests unitaires et d’intégration.
- L’intégration continue via GitLab CI/CD.
- Les bonnes pratiques de développement en équipe.
Vous travaillerez sur **une API REST de gestion de tâches** (*Todo List*), en la faisant évoluer progressivement.
---
## **1. Récupération du projet et première exploration**
1. Clonez le projet de base depuis le dépôt GitLab fourni :
```bash
git clone <URL_DU_REPO>
cd polytech-todo-api
```
2. **Explorez le code source** :
- `src/index.js` → Point d’entrée de l’application (serveur web).
- `src/todoService.js` → Contient la logique de gestion des tâches.
- `data/tasks.json` → Stocke les tâches initiales.
- `tests/` → Contient des tests unitaires et d’intégration.
- `.gitignore` → Fichiers à exclure du versioning Git.
- `.eslintrc.json` → Configuration du linter ESLint.
---
## **2. Exécution et tests locaux**
### **Installation des dépendances**
Avant toute chose, installez les dépendances du projet :
```bash
npm install
```
Cela télécharge et installe toutes les bibliothèques nécessaires définies dans `package.json`.
---
### **Vérification du fonctionnement de l'application**
Lancez le serveur :
```bash
npm start
```
Cela démarre l’API sur `http://localhost:3000`. Vérifiez que l’endpoint suivant répond bien :
```bash
curl http://localhost:3000/status
```
Réponse attendue :
```json
{"status":"ok"}
```
---
### **Analyse du linter (ESLint)**
Le linter sert à garantir que votre code respecte des règles de style et de bonnes pratiques.
Exécutez :
```bash
npm run lint
```
- En cas d’erreur, ESLint vous indiquera les corrections à apporter.
- Consultez `.eslintrc.json` pour comprendre les règles définies.
---
### **Exécution des tests**
Le projet contient des **tests unitaires** (sur `todoService.js`) et des **tests d’intégration** (sur les endpoints).
Lancez tous les tests avec :
```bash
npm run test
```
- **Tests unitaires** : Vérifient que les fonctions du service renvoient les bonnes données.
- **Tests d’intégration** : Vérifient que l’API répond correctement aux requêtes.
Si un test échoue, analysez son message pour comprendre la cause.
---
## **3. Mise en place de votre projet GitLab**
### **Création de votre dépôt personnel**
1. **Sur GitLab**, créez un **nouveau dépôt** privé nommé `polytech-todo-api-votreNom`.
2. Supprimez le remote existant et ajoutez le vôtre :
```bash
git remote remove origin
git remote add origin https://gitlab.com/votreCompte/polytech-todo-api-votreNom.git
```
3. Poussez votre code sur GitLab :
```bash
git push -u origin main
```
### **Gestion des branches**
- **Main** : Contient la version stable (ne jamais pousser directement dessus).
- **Develop** : Branche principale pour le développement.
- **Feature branches** : Chaque nouvelle fonctionnalité doit être développée sur une branche dédiée.
Créez `develop` :
```bash
git checkout -b develop
git push -u origin develop
```
Puis, dans **GitLab > Settings > Repository** :
- Protégez `main` et `develop` pour empêcher les pushs directs.
- Activez l’option "Merge Request obligatoire".
---
## **4. Évolutions à implémenter**
### **1️⃣ Récupération d'une tâche par ID**
Ajoutez un nouvel **endpoint** :
- Route : `GET /api/tasks/:id`
- Retourne :
```json
{"id": 1, "description": "Faire les courses", "done": false}
```
- Réponse `404` si l'ID n'existe pas.
Modifiez `todoService.js` :
```javascript
function getTaskById(id) {
// Implémentez la logique ici
}
```
Ajoutez les **tests unitaires** et **tests d’intégration** associés.
---
### **2️⃣ Ajout d'une tâche**
Ajoutez un **endpoint** pour ajouter une tâche :
- Route : `POST /api/tasks`
- Reçoit :
```json
{"description": "Nouvelle tâche"}
```
- Génère un nouvel `id` et retourne :
```json
{"id": 3, "description": "Nouvelle tâche", "done": false}
```
Modifiez `todoService.js` :
```javascript
function addTask(description) {
// Implémentez la logique ici
}
```
Ajoutez **les tests correspondants**.
---
### **3️⃣ Suppression d'une tâche**
Ajoutez un **endpoint** pour supprimer une tâche :
- Route : `DELETE /api/tasks/:id`
- Répond `204 No Content` si OK, ou `404 Not Found` si l’ID est introuvable.
Modifiez `todoService.js` :
```javascript
function deleteTask(id) {
// Implémentez la logique ici
}
```
Ajoutez les **tests unitaires et d’intégration**.
---
## **5. Mise en place de GitLab CI/CD**
Créez un fichier `.gitlab-ci.yml` pour automatiser :
- **Linting**
- **Tests unitaires**
- **Tests d’intégration**
- **Exécution seulement sur `develop` et `main`**
### **Mots-clés à utiliser dans le fichier `.gitlab-ci.yml`**
Au lieu de donner un fichier complet, voici les éléments à inclure et pourquoi :
| **Mot-clé** | **Explication** |
|------------|---------------|
| `image: node:16` | Utilise une image Docker avec Node.js 16, identique à votre VM. |
| `stages:` | Définit les étapes de la CI (`install`, `lint`, `test`). |
| `cache:` | Permet de réutiliser `node_modules` pour accélérer les jobs. |
| `script:` | Liste les commandes à exécuter (`npm install`, `npm run test`, etc.). |
| `only:` | Restreint l'exécution de certains jobs aux branches `develop` et `main`. |
| `before_script:` | Exécute `npm install` avant chaque étape. |
| `artifacts:` | Sauvegarde les fichiers de sortie utiles après l’exécution d’un job. |
Ajoutez ces éléments dans votre `.gitlab-ci.yml`, poussez et vérifiez que la CI s’exécute correctement.
---
## **6. Processus de validation finale**
1. **Assurez-vous que votre pipeline GitLab CI fonctionne**.
2. **Faites une Merge Request** de `develop` vers `main`.
3. **Ajoutez votre professeur comme reviewer**.
4. **Lors du merge sur `main`**, un script externe vérifiera la validité des tests.
5. **Si tout est OK, votre Merge Request sera validée**.
---
## **🎯 Récapitulatif des livrables attendus**
- Une API fonctionnelle avec les endpoints demandés.
- Un projet GitLab bien structuré (`main`, `develop`, branches protégées).
- Un `.gitlab-ci.yml` opérationnel.
- Des tests unitaires et d’intégration pour chaque fonctionnalité.
- Un merge propre vers `main` validé par la CI.
Bonne chance ! 🚀
=======
# Polytech Todo Api Abouchtita
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://etulab.univ-amu.fr/b23026204/polytech-todo-api-abouchtita.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://etulab.univ-amu.fr/b23026204/polytech-todo-api-abouchtita/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
>>>>>>> e8ac602d8fcc0778bc30586fa32f007c9d612c65
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment