README

Installation

Installer le bundle via Composer : composer require farmpublic/farmdatabasebundle

Compatibilité Symfony

Le bundle est compatible avec Symfony 7.4 et 8.0. Pour forcer l'utilisation de Symfony 7.4 lors du développement du bundle, utilisez la commande suivante :

composer update symfony/* --with symfony/*:^7.4

Documentation

• API Client
  • AdresseData
    • Permet via API de récupérer les données d'adresse depuis une adresse ou une latitude/longitude et inversement
  • Dashdoc
    • Permet de gérer les données en DTO, d'avoir un client API et Webhook
    • BaseTmsApiClient est fortement lié
  • MerciFacteur
    • Permet de gérer les données en DTO, d'avoir un client API et Webhook
  • OpenAI
    • Permet d'avoir un client OpenAI (qui peut analyser des logs)
  • Docupilot
    • Permet de créer des documents à partir de templates Docupilot
  • Supabase (API)
    • Permet d'avoir un client API et un SupabaseApiAuthenticator
• Structure du dossier src/
• Security
• Services
  • Exporter
    • Permet d'avoir un service d'export CSV et Excel
  • Encryption
    • Permet d'avoir un service d'encryption
  • Logger
    • Permet d'avoir un service de logger
  • S3
    • Permet d'avoir un service S3
  • Synchro
    • Permet de synchroniser des tables entre deux bases supabase
  • FTP
    • Permet d'avoir un service FTP

Contribuer au projet

📜 Règles de codage

• Application des règles de code standard Symfony
• Application des standards PSR-1, PSR-2, PSR-4 et PSR-12
• Indentation = 4 espaces

🔥 Merge Request

• Les "Merges Requests" sont RECOMMANDÉS, et la relecture de code entre pairs et vivement recommandé.

• Pour les changements majeurs, veuillez en discuter avec le reste de l'équipe.

☑️ Tests et pipeline

• Veuillez vous assurer de mettre à jour les tests le cas échéant ou d'en écrire de nouveaux pour couvrir vos ajouts.

• Veuillez également vous assurer que vos modifications passent le pipeline d'intégration continue.

• Pour lancer les tests localement, veuillez lancer la commande suivante (Nécessite Makefile).

make tests

• Pour lancer l'évaluation de la couverture de code, veuillez lancer la commande suivante :

make coverage

• Le rapport de couverture de code est disponible dans le repertoire ./var/coverage/

📦 Gestion des versions (tags)

Nous utilisons Semantic Versioning pour la gestion des versions. Pour publier une nouvelle version, il suffit de créer un tag de la forme x.y.z depuis l'interface GitLab (en ce basant sur la branche main).

🧑🏾‍🤝‍🧑🏼 Code de Conduite

Dans l'intérêt de favoriser un environnement ouvert et accueillant, nous nous engageons à faire de la participation à ce projet une expérience exempte de harcèlement pour tout le monde, quel que soit le niveau d'expérience, le sexe, l'identité ou l'expression de genre, l'orientation sexuelle, le handicap, l'apparence personnelle, la taille physique, l'origine ethnique, l'âge, la religion ou la nationalité.