Skip to content

About

Projet développé dans le cadre de l'examen RNCP 37273.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

107 Commits

Folders and files

Repository files navigation

Ancres Logicielles

Ancres Logicielles est une application web communautaire francophone dédiée au partage de liens autour des logiciels. Pensée comme un espace de veille et d’échanges, elle centralise des liens, permet de découvrir des outils, d’évaluer des propositions et de discuter de bonnes pratiques.

Ce dépôt contient une application MVC écrite en PHP, livrée avec un environnement Podman (FrankenPHP + MariaDB) pour faciliter l’exécution locale. Les tests ont été réalisés avec Podman, ce qui est désormais la référence de cette documentation.

⚠️ Avertissement

  • Ce projet a un objectif strictement pédagogique et de découverte/apprentissage.
  • Il n’a pas vocation à être déployé en production.
  • La sécurité, la robustesse, la performance et le support long terme ne sont pas garantis.

Sommaire

  • Contexte et objectifs
  • Fonctionnalités principales
  • Architecture du projet
  • Prérequis
  • Démarrage rapide (Podman)
  • Rôles, statut invité et comptes de test
  • Configuration (variables d’environnement)
  • Base de données (initialisation)
  • Développement (structure MVC, routes, logs)
  • Limitations actuelles et pistes d’amélioration
  • Licence

Contexte et objectifs

  • Projet réalisé dans le cadre de l’examen RNCP 37273 (https://www.francecompetences.fr/recherche/rncp/37273/).
  • Application « from scratch » en architecture MVC avec opérations CRUD.
  • Objectif double : démonstration de compétences et base pour de futures évolutions.

Fonctionnalités principales

  • Parcourir la liste des logiciels proposés (accueil).
  • Afficher le détail d’un logiciel.
  • Authentification basique (inscription, connexion, déconnexion).
  • Outils de modération (publier/dépublier, bannir/débannir) pour les rôles adéquats.

Remarque : L’application est encore partiellement incomplète et certaines fonctionnalités peuvent être non finalisées.

Architecture du projet

Arborescence condensée :

  • app/
    • public/
      • index.php (point d’entrée HTTP)
      • css/, js/, img/, fonts/ (actifs front)
    • config/
      • app.php, databaseMariaDB.php, paths.php, routes.php (constantes et définition des routes)
    • core/
      • Application.php, Router.php, Request.php, Response.php, ViewBuilder.php, etc. (noyau MVC)
    • core-utils/
      • Database/, Logger/, Session/, UserInterface/
    • src/
      • Controllers/ (AccountsController, PostsController, SupportsController, ErrorsController)
      • Models/ (PostModel, AccountModel, GradeModel)
      • Views/ (Vues PHP pour comptes, posts, supports et erreurs; layouts)
    • var/log/
      • messages.log (journal applicatif)
  • deployment/
    • frankenphp/ (build PHP)
    • database/ (build MariaDB + SQL d’initialisation)
    • default.env (variables d’environnement par défaut)
  • compose.yaml (stack Podman/containers)
  • README.md (ce fichier)

Points clés techniques :

  • Autoload « maison » des classes de l’espace de noms App\ vers le code applicatif.
  • Gestion d’erreurs centralisée dans app/public/index.php ; affichage des vues d’erreur.
  • Logger applicatif écrivant dans app/var/log/messages.log.
  • Routes déclaratives dans app/config/routes.php (regex sur chemin, requête, méthode, rôle, contrôleur, action et nature Ajax/non-Ajax).

Prérequis

  • Podman et Podman Compose (ou podman-compose) installés.
  • OS compatible (Linux) (à tester macOS, Windows).

Démarrage rapide (Podman)

1 : Cloner le dépôt :

2 : Créer et lancer les conteneurs Podman :

  • podman compose up --build --wait --remove-orphans

3 : Accéder à l’application :

4 : Arrêt et nettoyage du volume database (ATTENTION, supprime les données) :

  • podman compose down -v --remove-orphans

Rôles, statut invité et comptes de test

  • Statut invité (guest) : toute personne qui visite le site sans être authentifiée dispose du statut « guest ».
    • Accès en lecture seule aux pages publiques (accueil, fiches logiciels, pages "À propos" et "Politiques").
    • Les actions d’écriture (insérer, publier, modérer, etc.) nécessitent une authentification et les rôles appropriés.
  • Comptes de test (environnement local) :
    • Utilisateur régulier (registered) :
      • Identifiant/pseudo : regularuser
      • Mot de passe : regularuserPasswd0
    • Administrateur (admin) :
      • Identifiant/pseudo : admin
      • Mot de passe : adminPasswd0
  • Connexion et déconnexion :
  • Remarque : ces comptes de démonstration sont provisionnés via le script d’initialisation de la base (deployment/database/docker-entrypoint-initdb.d/ancres-logicielles.sql).

Configuration (variables d’environnement)

Le stack Podman utilise un fichier de configuration d’environnement chargé au démarrage des services. Par défaut, ce projet attend un fichier .env à la racine du dépôt.

Les valeurs par défaut sont fournies dans le fichier default.env. Les variables principales sont les suivantes :

  • MARIADB_DRIVER: moteur de base de données utilisé par l’application (mysql par défaut)
  • MARIADB_HOST: nom du service de base de données utilisé par le conteneur PHP (db)
  • MARIADB_PORT: port d’écoute interne de MariaDB (3306)
  • MARIADB_DATABASE: nom de la base de données utilisée par l’application (ancres-logicielles)
  • MARIADB_USER: utilisateur principal de la base de données (al)
  • MARIADB_PASSWORD: mot de passe associé à l’utilisateur de base de données
  • MARIADB_ALLOW_EMPTY_ROOT_PASSWORD: autorisation de configuration locale sans mot de passe root (1)

Pour personnaliser votre environnement local, copiez default.env vers .env puis adaptez les valeurs selon vos besoins. Veillez à ne pas versionner de secrets sensibles en clair.

Base de données (initialisation)

  • Le service « db » est basé sur l’image MariaDB 12.
  • Un fichier SQL d’initialisation est copié au build : deployment/database/docker-entrypoint-initdb.d/ancres-logicielles.sql.
  • Au premier démarrage (volume vide), MariaDB initialisera la base avec ce script.

Changer ou rejouer l’initialisation :

  • Supprimer le volume pour forcer une réinitialisation : podman compose down -v && podman compose up --build

Développement

Entrée applicative :

  • app/public/index.php configure l’autoload, installe des handlers d’erreurs et lance App\Core\Application.

Logs :

  • Les erreurs/exceptions sont journalisées via App\Utils\Logger dans app/var/log/messages.log.

Routes (extraits majeurs depuis app/config/routes.php) :

  • GET / ou /posts/indexSoftwares → PostsController::indexSoftwares (accueil)
  • GET /posts/showSoftware?id=ID → PostsController::showSoftware
  • GET|POST /posts/addSoftware (rôles: moderator|admin)
  • POST (Ajax) /posts/{publish|unpublish|ban|unban|updatePostboxModTool|updateSoftwareStatus} (rôles: moderator|admin)
  • GET /supports/about, /supports/policies
  • GET|POST /accounts/signup (guest), /accounts/login (guest)
  • GET|POST /accounts/logout (registered|moderator|admin)

Vues et layouts :

  • app/src/Views/... regroupe les pages, layouts de navigation, notifications et statuts des posts.

Modèles :

  • app/src/Models/ gère l’accès aux données (PDO MySQL) conformément aux paramètres de app/config/databases.php.

Front-end :

  • app/public/css/style.scss (SASS) → style.css. JavaScript dans app/public/js/main.js. Polices et icônes sous app/public/.

Certificats/HTTPS local :

  • FrankenPHP latest gère le HTTPS interne. L’URL est exposée sur https://localhost:8443/. Selon votre navigateur, vous devrez peut-être accepter un certificat non approuvé en local.

Limitations actuelles et pistes d’amélioration

  • Fonctionnalités incomplètes : certaines parties CRUD et flux d’authentification/modération peuvent être partiellement implémentées.
  • Base de données de démonstration : les données de test sont limitées au script d’initialisation fourni.
  • Sécurité à renforcer pour une mise en production (gestion des secrets, configuration TLS, en-têtes HTTP, validation/filtrage).
  • Tests automatisés absents : ajouter des tests unitaires/fonctionnels (PHPUnit) et un workflow CI.
  • Gestion des requêtes Ajax en erreur : TODO mentionné dans index.php pour mieux gérer les réponses JSON en cas d’exception/erreur.
  • Documentation développeur à enrichir (contributions, conventions de code, roadmap détaillée).
  • Enregister les messages d'erreurs dans un espace autre que le dossier de l'application

Pistes futures :

  • Pagination/filtrage avancés pour la liste des logiciels.
  • Système de votes/commentaires.
  • Rôles et permissions plus granulaires.
  • API REST/JSON pour intégrations tierces.

Captures d'écran

Écran d'accueil petit

Écran d'accueil moyen

Écran d'accueil grand

Licence

Code : MIT License © 2025 jacques jdevelopquest — voir le fichier LICENSE. Documentation : CC BY 4.0 © 2025 jacques jdevelopquest — https://creativecommons.org/licenses/by/4.0/ Éléments tiers (icônes, polices, images, etc.) : conservent leurs licences respectives — voir THIRD_PARTY.md.

About

Projet développé dans le cadre de l'examen RNCP 37273.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages