From 930911fd203b19bdb87d57ec8f69ea0cd3e99605 Mon Sep 17 00:00:00 2001 From: BAROU Romain <romain.barou@imt-atlantique.net> Date: Wed, 16 Feb 2022 21:51:56 +0000 Subject: [PATCH] Update README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 1854f93..d76ad9c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# ! English Below ! + # Projet infrastructure IMT Atlantique 2A Cynthia ANDRIAMPARIVONY, Victoire LENGLART,Martin KEYLING, Romain BAROU, IMT Atlantique FIL A2, Promotion 2023 @@ -29,3 +31,41 @@ Lancer l'IHM: ` npm run serve ` #### Depuis la racine du projet: `./build.sh` Les éxécutables sont disponibles dans le sous répértoire `builded_files` + +# English Version + +# infrastructure's project IMT Atlantique 2A +Cynthia ANDRIAMPARIVONY, Victoire LENGLART,Martin KEYLING, Romain BAROU, +IMT Atlantique FIL A2, Promotion 2023 + +# Start the project: + +## When the MQTT broker and the server are launched, from the project's root: + +### start a publisher: +#### from the cmd repository from the publishers sub repository: +Pressure captor : ` go run ./pressureCaptor/pressureCaptor.go ` +temperature captor : `go run ./tempCaptor/tempCaptor.go` +Wind captor : ` go run ./windCaptor/windCaptor.go ` + +### start a subscriber: +#### from the cmdr repository from subscribers sub repository: +Subscriber for Redis: ` go run ./subDB/subDB.go ` +Subscriber for csv: ` go run ./subCSV/subCSV.go ` +csv files are avaible here: %appdata%/measuresCSV + +### Start the API: +#### from the cmd repository from the API sub-repository: +start ` go run ./api/api.go ` +L'API est hosted here ` http://localhost:8080/ ` +the documentation is avaible here ` http://localhost:8080/swagger/ ` + +### Start the HMI: +#### from the repository IHM\\infrastructure-ihm: +Initiate node modules: ` npm install ` +Start HMI : ` npm run serve ` + +### Generate .exe files: +#### From the project's root: +`./build.sh` +.exe are avaible in the file : `builded_files` -- GitLab