diff --git a/readme.rst b/readme.rst index b6520080e9129a539e2c820c09060b1e38db1db7..2399cb7c922b40480d43a99782f5a1ccf13b3493 100644 --- a/readme.rst +++ b/readme.rst @@ -1,39 +1,35 @@ ################### -What is CodeIgniter +Firediag ################### -CodeIgniter is an Application Development Framework - a toolkit - for people -who build web sites using PHP. Its goal is to enable you to develop projects -much faster than you could if you were writing code from scratch, by providing -a rich set of libraries for commonly needed tasks, as well as a simple -interface and logical structure to access these libraries. CodeIgniter lets -you creatively focus on your project by minimizing the amount of code needed -for a given task. - ******************* -Release Information +Objectif ******************* -This repo contains in-development code for future releases. To download the -latest stable release please visit the `CodeIgniter Downloads -<https://codeigniter.com/download>`_ page. - -************************** -Changelog and New Features -************************** - -You can find a list of all changes for each release in the `user -guide change log <https://github.com/bcit-ci/CodeIgniter/blob/develop/user_guide_src/source/changelog.rst>`_. +En 2016, les 246.800 sapeurs-pompiers français ont effectué plus de 4.542.400 interventions, c'est-à -dire près de 12.445 interventions par jour. Chaque année, une dizaine d’entre eux périssent tragiquement au cours de leurs missions. Flammes, fumée, torrents d’eau, ces hommes et femmes se battent chaque jour afin de sauver d’autres personnes en dépit d’un environnement extrêmement hostile. C’est dans le but de réduire les risques au minimum que les sapeurs-pompiers recherchent en permanence de nouvelles solutions technologiques. +Les pompiers étant des acteurs primordiaux de la société, développeurs, chercheurs et fabricants s’empresse de comprendre et de créer le pompier de demain. Ainsi, nous nous sommes également intéressés à ce problème et plus particulièrement à la gestion et au traitement de tous ces nouveaux outils qui apparaissent afin d’aider les pompiers dans leur tâche. +Nous avons donc travaillé sur un tableau de bord dans le but d’observer, enregistrer et analyser les données issues de différents types de capteurs ******************* -Server Requirements +Structure ******************* -PHP version 5.6 or newer is recommended. +La structure de l’application est conçu de la façon suivante : +- Toutes sortes de capteurs envoient leurs données au broker MQTT directement ou en utilisant un intermédiaire. + +- Un broker MQTT dont le rôle est de récupérer les messages envoyées sur un topic et les redistribuer aux clients inscrits à ces topics. +Serveur MQTT : Mosquitto + +- Une application Web divisée en deux grosses parties : la partie “Analyse†qui permet de rechercher et d’étudier les données de la base de données, puis la partie “Live†qui elle récupère directement les données émises par le broker MQTT afin de les afficher à l’utilisateur. Notez toutefois que la première itération de l’affichage dans la partie “Live†provient des données en base. +Serveur Web : Apache2 +Back-End Framework : CodeIgniter +Front-End Framework : INSPINIA -It should work on 5.3.7 as well, but we strongly advise you NOT to run -such old versions of PHP, because of potential security and performance -issues, as well as missing features. +- Une base de données classique qui conserve toutes les données dans le but de les étudier par la suite. Elle permet également le bon fonctionnement de l’application en conservant les utilisateurs et les modèles utilisées. +Système de Gestion de Base de Données : MySQL + +- Enfin, des scripts permettent la transition des données du broker MQTT à la base de données. Ce sont eux qui s’occupent notamment de la création des alertes et des notifications, en plus d’assurer un monitoring de l’application. +Langage : Python ************ Installation @@ -49,22 +45,3 @@ License Please see the `license agreement <https://github.com/bcit-ci/CodeIgniter/blob/develop/user_guide_src/source/license.rst>`_. -********* -Resources -********* - -- `User Guide <https://codeigniter.com/docs>`_ -- `Language File Translations <https://github.com/bcit-ci/codeigniter3-translations>`_ -- `Community Forums <http://forum.codeigniter.com/>`_ -- `Community Wiki <https://github.com/bcit-ci/CodeIgniter/wiki>`_ -- `Community Slack Channel <https://codeigniterchat.slack.com>`_ - -Report security issues to our `Security Panel <mailto:security@codeigniter.com>`_ -or via our `page on HackerOne <https://hackerone.com/codeigniter>`_, thank you. - -*************** -Acknowledgement -*************** - -The CodeIgniter team would like to thank EllisLab, all the -contributors to the CodeIgniter project and you, the CodeIgniter user.