Skip to content

Monitoring-Mtl/Serverless-API

Repository files navigation

GitHub contributors GitHub last commit (branch) GitHub issues GitHub top language


Logo

Monitoring Mtl - Serverless API

Projet de fin d'etude - Automne 2023 - ETS Montreal
Explorer la documentation »

Table des matières
  1. A propos du projet
  2. Pour débuter
  3. Utilisations
  4. Plan de développement
  5. Contribuer
  6. Contact
  7. Reconnaissances

A propos du project



Dans le contexte des villes intelligentes, des systèmes de transport intelligents, et de la mobilité durable, le développement de solutions logicielles permettant de mieux comprendre l'impact de divers facteurs (par exemple, les incidents routiers, la construction et la météo) sur la circulation devient un élément essentiel de la gestion du trafic routier. L’émergence récente des données ouvertes, comme celles fournies par la Ville de Montréal et la STM, permet maintenant de développer divers types de solutions/applications logicielles qui contribuent à l’amélioration de la qualité de vie dans les villes.


Le but de cette application:

  • Développer une application infonuagique qui collect des données (en temps réels)
  • Analyser les données recueillient
  • Construire une interface pour visualiser les données analyser

**Les fonctionnalités mentionnées ci-dessus sont à titre d'exemple pour clarifier l'objectif de chaque composant (micro-service)

(haut)

Construit Avec

Voici la liste des frameworks et des outils que nous utilisons dans le projet :

  • NodeJS
  • TypeScript
  • AWS
  • GitHub
  • GitHubActions
  • AmazonDynamoDB
  • ExpressJS
  • EsLint
  • NPM

(haut)

Pour Débuter

Voici la procédure à suivre pour installer et lancer le projet. IMPORTANT ! si vous n'avez pas NodeJS / NPM cliquez-ici

Prérequis

Pour mettre a jour votre version de npm à la plus récente

  • npm
    npm install npm@latest -g

Installation

Vous trouverez ci-bas un exemple de la procédure pour installer le projet localement, ainsi que lancer le projet pour tester que votre environnement de travail est fonctionnel.

  1. Obtenir une clé d'API gratuite de la STM a Stm Portail Développeur
  2. Cloner le repertoire
    git clone https://github.com/Monitoring-Mtl/Serverless-API.git
  3. Install NPM packages
    npm install
  4. Configurer les identifiants AWS
    export AWS_ACCESS_KEY_ID=<access-key-id> AWS_SECRET_ACCESS_KEY=<secret-access-key>
  5. Lancer le serverless local
    npm run offline

(haut)

Utilisation

Pour utiliser les endpoints de l'application visiter swagger
Pour contribuer ou mettre a jour la documentation Swagger, voir ce repertoire

Rapport de couverture de tests

Pour visualier le rapport de couverture de tests et ses résultats, visiter : coverage-report

Pour plus d'informations, référez-vous à la Documentation

(haut)

Plan de Développement

  • Ajouter les endpoints nécessaires
  • Ajuster et automatiser le Pipeline
  • Collection des données
  • Faire la documentations
  • Ajouter middlewares

Voir les issues pour voir les Features (et issues connuent).

(haut)

Contribuer

En esperant que le projet continue de croître grâce a vos contributions. Merci

Nous avons décider d'utiliser une structure de Trunk base pour la gestion des branches. Il est donc suggérer de toujours faire une branche a partir de master en suivant la procédure suivante :

  1. Cloner le Project (si ce n'est pas déjà fait)
  2. Creer un branche Feature ou Documentation (git checkout -b feature/AmazingFeature)
  3. Commit vos Changements (git commit -m 'ajout d'une AmazingFeature')
  4. Pousser la Branch (git push origin feature/AmazingFeature)
  5. Ouvrir une Pull Request et associer votre issue à la PR.

(haut)

Contact

Étudiants

(haut)

Reconnaissances

Remerciements à

(haut)

About

Service AWS Lambda pour deservir le front-end

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 10