Documentation Mines App

Appearance

Documentation Mines AppLa définition du projet et le guide de référence de toute la stack

Un site de documentation central pour comprendre le produit, ses fonctionnalités, son architecture, son infrastructure et ses workflows de contribution.

Comprendre le produit
Parcourir les modules
Explorer l'architecture

Vision produit

Poser le cadre du projet, sa mission, son périmètre et sa direction avant de discuter d'implémentation.

Fonctionnalités métier

Décrire chaque module métier, sa valeur d'usage et les contraintes qu'il impose ensuite à la stack.

Onboarding progressif

Aider les juniors à découvrir la stack avec des tutoriels, du contexte et une documentation agréable à parcourir.

Réalité actuelle Frontend React 19, backend Spring Boot 3.2 en submodule, PostgreSQL 15, stack locale containerisée et modules médias comme JTM ou la musique.
Rôle de cette documentation Ce dépôt explique ce qu'est le projet, pourquoi il existe et comment il doit évoluer proprement quand l'architecture se découpera davantage.
Public visé Étudiants, mainteneurs, responsables techniques et nouveaux contributeurs qui doivent comprendre rapidement le produit et sa stack.

Ce que couvre cette documentation ​

  • la vision du projet et son cahier des charges
  • les fonctionnalités et leur objectif métier
  • l'architecture frontend, backend, base de données et infrastructure
  • les contraintes induites par les médias, les fichiers et le streaming
  • les tutoriels d'installation, de contribution et d'exploitation

Commencer ici ​

Pensée pour l'onboarding, la transmission et les décisions d'architecture.

Mines Nancy App