Introduction au code

N’ayez pas peur ! Le code est écrit de manière accessible afin que vous puissiez y contribuer facilement. Si vous êtes à l’aise avec les méthodes plus “standard” dans l’industrie, il est possible de coder de votre côté et de communiquer via l’API.

Ressources pour débuter

Architecture

Le motif utilisé est le classique Modèle-vue-contrôleur. Une grosse partie du code se trouve dans le dépôt CO2 de notre Github, tandis que citizenToolKit gère plutôt le backend.

Construction d’une URL

Les URL sont gérées par co.js et se présentent sous la forme suivante : /ph/[module]/#[application]

  • module correspond à une fonction de base. Par exemple le module CO2 gère, entre autre, l’affichage, network permet d’afficher des cartes et API gère… l’API.). Un gros travail de moduralisation est en cours.
  • application fait référence aux applications utilisateurs. Elles sont déclarées dans params.json. Le paramètre hash défini quel contrôleur sera utilisé. Les contrôleurs se trouvent dans co2/controllers, et définissent quelle vue va être chargée (liste des vues).

Par exemple la page communecter.org/#search correspond à la vue co2/views/app/search.php.

Back to top