Avant-propos

Quizine est la première application que je réalise intégralement et mets à disposition des internautes. Elle constituera ma vitrine en tant que développeur junior. C’est pourquoi son code est en libre accès sur GitHub et que je produis cette documentation en parallèle, afin de partager le processus de sa conception au fur et à mesure. L’objectif est de fournir un aperçu détaillé de la réflexion derrière le projet, des choix techniques effectués et des étapes de son développement.

Cette documentation vise à détailler en profondeur le fonctionnement de Quizine, de sa conception à son utilisation. Elle est structurée en trois grandes parties :

Concepts généraux : Présentation des principes de conception du projet, des choix technologiques, des aspects DevOps ainsi que de la structure de la base de données sur laquelle l’API repose.
Client (frontend) : Explication de l’interface utilisateur, des technologies employées et des interactions avec l’API.
API (backend) : Documentation des endpoints, des modèles de données et des mécanismes de sécurité et d’authentification.

Cette organisation vise à offrir une vision complète du projet que je vais réaliser de A à Z, depuis la phase de réflexion initiale, à travers le développement frontend et backend, jusqu’à la mise en ligne et l’exploitation concrète sur le web.

Objectif

Cette démarche a pour but de servir également d’outil de mémorisation pour mes futures conceptions utilisant les technologies employées. Elle peut aussi être utile à d’autres développeurs dans des situations similaires, ou à ceux souhaitant apprendre à utiliser les technologies choisies pour ce projet.

Toute remarque visant à améliorer la qualité de ce projet est la bienvenue. N’hésitez pas à me contacter pour me faire part de vos suggestions, critiques ou questions (en m’envoyant un message sur LinkedIn, par exemple).

Public cible

Je vais tenter de vulgariser au maximum les concepts abordés dans cette documentation, bien que certains d’entre eux puissent ne pas être accessibles à tous. Il est plutôt recommandé de posséder des connaissances de base en programmation et en conception logicielle, même si une expertise dans les technologies spécifiques de ce projet n’est pas requise.

Autres parties

Concepts généraux

Pour consulter la partie des concepts généraux de l’application, c’est par ici.

Back-end

Pour consulter la partie back-end de l’application, c’est par ici.