openMairie Framework 4.5 documentation

Note

Cette création est mise à disposition selon le Contrat Paternité-Partage des Conditions Initiales à l’Identique 2.0 France disponible en ligne http://creativecommons.org/licenses/by-sa/2.0/fr/ ou par courrier postal à Creative Commons, 171 Second Street, Suite 300, San Francisco, California 94105, USA.

Ce document a pour but de guider les développeurs dans la mise en œuvre d’un projet openMairie.

Avec plus de 50 applications développées pour les collectivités locales accessibles sur le site http://www.openmairie.org, nous souhaitons au travers de ce guide, diffuser notre expérience auprès des collectivités et des acteurs économiques du libre qui les accompagnent.

C’est donc une méthode conçue au fur à mesure de nos développements que nous vous proposons de partager et toutes remarques sont les bienvenues, alors n’hésitez pas à nous en faire part sur le forum du framework : https://communaute.openmairie.org/c/framework .

Nous avons conçu openMairie pour fabriquer une maquette grâce au générateur le plus en amont possible en s’appuyant sur le modèle de données et en intégrant des composants standards du “monde libre”.

Cette maquette permet très rapidement d’engager un dialogue participatif avec les utilisateurs, de concentrer le développeur uniquement sur le “métier” et de faire valider par l’utilisateur les évolutions successives.

Si vous débutez, il est préférable de commencer par le tutoriel “créer une application” qui permet de prendre en main facilement le générateur et le framework openMairie en vous guidant pas à pas dans le mise en place d’une gestion de courrier.

Le manuel d’usage complète l’exemple ci-dessus en vous décrivant le fonctionnement du framework : ergonomie, administration, génération, intégration, ...

Le manuel de référence s’adresse plus aux utilisateurs confirmés en décrivant le paramétrage, les classes formulaires et éditions du framework. Il a pour but de vous informer de manière complète sur le fonctionnement du framework.

Un chapitre particulier est dédié aux tests et à l’intégration continue. Le framework openMairie possède des tests unitaires et fonctionnels joués intégralement à chaque modification du code source afin d’assurer sa stabilité et sa pérennité.

Un chapitre est consacré à l’historique des versions du framework et aux conseils pour les mises à niveau.

Ce document rassemble enfin toutes les règles de codage du projet openMairie, ainsi que des outils pour aider et guider les développeurs de la communauté. Les règles indiquées doivent être appliquées pour qu’un projet puisse intégrer la distribution openMairie car l’objectif est de faciliter la lisibilité et la maintenance du code ainsi que la prise en main par les collectivités.

Toutes les dernières infos sur le framework sont disponibles ici : http://www.openmairie.org/framework. Bonne lecture !

Contributeurs

(par ordre alphabétique)

  • APITUX
  • atReal
  • Alain Baldachino
  • Jean Christophe Becquet
  • Thierry Benita
  • Romain Beylerian
  • Matthias Broquet
  • Laurent Groleau
  • Nicolas Haye
  • Jean-Yves Madier de Champvermeil
  • Nicolas Meucci
  • Florent Michon
  • Virginie Pihour
  • Francois Raynaud
  • Sofien Timezouaght