bloumix / proxym-compte-rendu-activite

Gestion des comptes-rendu d'activités

Une application permettant de gérer efficacement les comptes-rendus d'activité mensuels des employés au sein de l’entreprise. L'objectif principal de cette application est de faciliter le suivi et la gestion des activités effectuées par les différents membres. Elle offre un moyen centralisé et efficace de saisir, stocker et consulter les comptes rendus, pour permettre une meilleure traçabilité et de mieux suivre l'évolution des projets,des activités et même la gestion des périodes d’absences et congés.

---

Guide d'Installation

Ce guide d’installation aborde comment mettre en place et exécuter l'application "Gestion des Comptes-Rendus d'Activités (CRA)" localement .

Étape 1 : Clonage du Projet

1. Clonez ce dépôt sur votre machine locale.

git clone https://github.com/proxym-france/proxym-compte-rendu-activite.git

Étape 2 : Utilisation de Docker

Pour exécuter l'application en utilisant Docker.

1. S’assurer d'avoir Docker et Docker Compose installés sur votre machine.

2. Naviguer vers le dossier docker dans le projet.

cd docker

3. Démarrer tous les services (base de données, backend, frontend) :

docker-compose up -d

Cela lancera les conteneurs pour la base de données, le backend et le frontend. Une fois les conteneurs en cours d'exécution, vous pourrez accéder à l'application web à l'adresse http://localhost:3000. Cela crée également la base de données ‘proxym_cra’ en utilisant le script init.sql. 4. Pour arrêter tous les conteneurs, exécutez :

docker-compose down

Exécution de Services Individuels

Vous pouvez également exécuter des services individuels séparément à l'aide de Docker Compose.

Exécution du Service de la Base de Données

Pour exécuter uniquement le service de la base de données :

docker-compose up -d database

Exécution du Service Backend

Pour exécuter uniquement le service backend :

docker-compose up -d backend

Exécution du Service Frontend

Pour exécuter uniquement le service frontend :

docker-compose up -d frontend

Étape 3 : Sans l’utilisation de Docker

Si vous voulez installer et exécuter l'application dans un environnement classique sans utiliser Docker, suivez les étapes suivantes :

1. Installer Node.JS
2. Mettre en place un serveur web (Apache ou autre)
3. Installer et configurer mysql
4. Créer la base de donnees ‘proxym_cra’
5. Démarrer le backend :

Cd back

npm install

npm run start

6. Démarrer le frontend :

cd front

npm install

npm run

---

Tests

Ce projet utilise le développement piloté par les tests (TDD) pour assurer la qualité du code. Les tests sont divisés en deux types : les tests unitaires et les tests end-to-end (e2e).

Pour exécuter les tests unitaires :

cd back
npm run test

Pour exécuter les tests e2e : bash

cd back
npm run test:e2e

---

Stack Technique

• Node.js (v18.15.0)
• Nest.js
• React
• MySQL
• TypeORM

---

Structure

Le projet "Gestion des Comptes-Rendus d'Activités (CRA)" est organisé de la manière suivante :

proxym-compte-rendu-activite/
│
├── cra-docs/
│   ├── (Documentation du projet)
│
├── docker/
│   ├── docker-compose.yml
│
├── front/
│   ├── (Projet React avec les composants)
│
├── back/
│   ├── test/
│   │   ├── (Tests unitaires et tests d'architecture utilisant TSArch)
│   │
│   ├── test_e2e/
│   │   ├── (Tests de bout en bout(end to end))
│   │
│   ├── src/
│   │   ├── controller/
│   │   │   ├── collab.controller.ts
│   │   │   ├── cra.controller.ts
│   │   │   ├── holiday.controller.ts
│   │   │   ├── project.controller.ts
│   │   │   ├── auth.controller.ts
│   │   │
│   │   ├── decorators/
│   │   │
│   │   ├── data/
│   │   │   ├── dataModel/
│   │   │   │
│   │   │   ├── Repository/
│   │   │
│   │   ├── domain/
│   │   │   ├── model/
│   │   │   │
│   │   │   ├── application/
│   │   │   │
│   │   │   ├── IRepository/
│   │   │   │
│   │   │   ├── service/
│   │   │
│   │   ├── DTO/
│   │   │
│   │   ├── guards/
│   │   │   
│   │   ├── app.module.ts
│   │   ├── app.service.ts
│   │   ├── main.ts
│   │   ├── test.module.ts
│
├── README.md

---

Description

• cra-docs/ : Ce dossier contient la documentation du projet cree en utilisant Docusaurus, L'objectif de ce site est de rassembler toute la documentation pertinente et toutes les informations liées au projet. Vous y trouverez des descriptions, des guides, des explications et choix techniques et bien plus encore.

• docker/ : Ce dossier contient le fichier docker-compose.yml qui définit la configuration Docker pour le déploiement des conteneurs nécessaires à l'exécution de l'application.

• front/ : Ce dossier contient le projet React. Vous y trouverez tous les composants, les styles et les ressources nécessaires à l'interface utilisateur de l'application.

• back/ : Ce dossier contient le code source du backend de l'application. Il est subdivisé en plusieurs sous-dossiers :

  • test/ : Ce dossier contient les tests unitaires qui visent à vérifier le comportement et la logique métier de l'application. Il comprend également des tests d'architecture utilisant la bibliothèque TSArch. Cette bibliothèque a été essentielle pour maintenir la cohérence architecturale à travers le code. Elle a permis de vérifier que les dépendances étaient correctement gérées et que chaque élément était positionné conformément à l'architecture globale.

  • test_e2e/ : Ce dossier contient les tests de bout en bout qui simulent les interactions pour valider les fonctionnalités de bout en bout de l'application entre les differents composants.

  • src/ : Ce dossier contient le code source du backend, organisé en plusieurs sous-dossiers :

    • controller/ : Ce dossier contient les contrôleurs qui gèrent les interactions utilisateur et les requêtes HTTP. Ils orchestrent les flux de données entre le frontend et le backend.

    • decorators/ : Ce dossier contient les décorateurs qui ajoutent des fonctionnalités spécifiques aux différentes parties de l'application.

    • data/ : Ce dossier contient les modèles de données utilise pour la creation de la base de données. Il inclut également les implémentations des Repository pour l'accès aux données.Ici l'ORM utilisé est TypeORM.

    • domain/ : Ce dossier contient les modèles de domaine encapsulant les règles métier, les interfaces IRepository pour l'accès aux données et les services implémentant la logique métier.

    • DTO/ : Ce dossier contient les objets de transfert de données utilisés pour échanger des informations entre les différentes parties de l'application.

    • guards/ : Ce dossier contient les gardiens de sécurité qui protègent les routes et les ressources de l'application.

    • app.module.ts : Fichier de configuration du module principal de l'application.

    • app.service.ts : Fichier de service principal de l'application.

    • main.ts : Point d'entrée pour le démarrage de l'application.

    • test.module.ts : Fichier de configuration des tests de l'application.