QualiNomme/README.md

81 lines
2.9 KiB
Markdown
Raw Normal View History

2024-02-20 14:24:37 +00:00
# Quali'Nomme 📚
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
Quali'Nomme est un outil conçu pour améliorer la qualité du nommage dans le code en facilitant l'identification des termes métiers et leur comparaison avec les glossaires spécifiés. Il a été développé dans le cadre d'une Situation d'Apprentissage et d'Évaluation (SAE).
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Objectif 🎯
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
L'objectif de Quali'Nomme est de faciliter l'amélioration de la qualité de nommage dans le code en fournissant les fonctionnalités suivantes :
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
- Ajout de un ou plusieurs glossaires en fonction des besoins du projet.
- Parsing d'un code ou d'un projet pour identifier les termes métiers utilisés et leur fréquence.
- Comparaison entre les termes saisis dans les glossaires et ceux identifiés dans le code.
- Visualisation des données comparatives pour une meilleure compréhension.
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Sommaire 📝
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
- [Objectif](#objectif-) 🎯
- [Sommaire](#sommaire-) 📝
- [Technologies Utilisées](#technologies-utilisées-) 💻
- [Technologies Prise En Charge Par Le Projet](#technologies-prise-en-charge-par-le-projet-) 🚀
- [Installation](#installation-) 🔧
- [Utilisation](#utilisation-) 🛠️
- [Auteurs](#auteurs-) 👥
- [Contact](#contact-) 📞
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Technologies Utilisées 💻
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
- ![Kotlin](https://img.shields.io/badge/Kotlin-0095D5?style=flat&logo=kotlin&logoColor=white)
- ![JetPack Compose](https://img.shields.io/badge/Jetpack%20Compose-6200EE?style=flat&logo=android&logoColor=white)
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Technologies Prise En Charge Par Le Projet 🚀
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
- ![Kotlin](https://img.shields.io/badge/Kotlin-0095D5?style=flat&logo=kotlin&logoColor=white)
- ![Java](https://img.shields.io/badge/Java-007396?style=flat&logo=java&logoColor=white)
- ![Python](https://img.shields.io/badge/Python-3776AB?style=flat&logo=python&logoColor=white)
- ![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=flat&logo=javascript&logoColor=black)
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Installation 🔧
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
Pour installer Quali'Nomme, suivez les étapes suivantes :
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
1. Clonez le dépôt
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
```sh
git clone
```
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
2. Installez les dépendances
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
```sh
./gradlew build
```
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
3. Exécutez le projet
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
```sh
./gradlew run
```
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Utilisation 🛠️
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
Pour utiliser Quali'Nomme, suivez les étapes suivantes :
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
1. Ajoutez un ou plusieurs glossaires en fonction des besoins du projet.
2. Parsez un code ou un projet pour identifier les termes métiers utilisés et leur fréquence.
3. Comparez les termes saisis dans les glossaires et ceux identifiés dans le code.
4. Visualisez les données comparatives pour une meilleure compréhension.
5. Améliorez la qualité de nommage dans le code.
6. Répétez les étapes 2 à 5 pour chaque itération du projet.
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Auteurs 👥
2023-09-18 13:58:20 +00:00
2024-02-20 14:29:36 +00:00
- [Maxime CAPEL](https://github.com/fortyup/)
- [Thomas BREIL](https://github.com/ThomasBreil)
- [Bayram Gokcen](https://github.com/ByrmGkcn)
- [Cemal ODABASIOGLU](https://github.com/sonwayy)
- [Clement Carpentier](https://github.com/ClementCrpt)
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
## Contact 📞
2023-09-18 13:58:20 +00:00
2024-02-20 14:24:37 +00:00
Pour toute question, veuillez contacter l'équipe de développement.