diff --git a/README.md b/README.md index d80fe53..867f8ce 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ + Manuel Hude (01502712) + Martin Schett (01633073) + Martin Weick (01627760) -+ Marco Zeisler (01628030) ++ Marco Zeisler (01628030) ## Who worked on what? @@ -19,29 +19,36 @@ ## How to start the program -* In the project root run: `docker-compose up -d` +* In the project root run: `docker-compose up --build -d` * Go to `http://localhost:8080` for the frontend * Run `docker ps` to see the container ID of the image aic_g4t2_iot_client -* Enter `docker exec -it /bin/bash` to enter the shell of the iot_client -* Get a usage message by entering `help` +* Enter `docker exec -it /bin/bash` to get a shell of the IoT-Client +* To start the simulated IoT-Client, run `python iot_client.py -t` +Alternatively you can use the provided Makefile: + +* Run `make start` to start all containers +* The frontend should now be available at `http://localhost:8080` +* To get into the IoT-Client, run `make iot` (needs `grep` and `awk`) +* `python iot_client.py -t` will start the simulation ## Technologies used * Python 3.8.6 with Django for the backend * Angular 9 for the frontend -* Dropbox API for an image storage -* AWS S3 as an object storage -* MongoDB as a metadata storage +* Dropbox API for storing images +* AWS S3 for object storage +* MongoDB for storing metadata ## Detailed description of a usecase -Follow: [How to start the program](#How-to-start-the-program) to setup the program. To simulate that a device sent some -picture enter `trigger` into the iot_client. You can now see the pictures distributed over the -different storages. Write `set 0` to position the cursor to the first image sent. Issue `update` to update the image. -The new image shows up in the dashboand and a new version in the corresponding storages is created. Navigate to the Map -in the frontend to see a location marker where the image was taken. - +Follow: [How to start the program](#How-to-start-the-program) to setup the +program. To simulate that a device sent some picture enter `trigger` into the +iot_client. You can now see the pictures distributed over the different +storages. Write `set 0` to position the cursor to the first image sent. Issue +`update` to update the image. The new image shows up in the dashboard and a +new version in the corresponding storages is created. Navigate to the Map in +the frontend and reload it to see a location marker where the image was taken. ## Credentials for AWS and Dropbox @@ -55,3 +62,5 @@ in the frontend to see a location marker where the image was taken. * Username: e01633073@student.tuwien.ac.at * Password: aicdropboxpassword + +The relevant folder where all images are uploaded to is called `AIC Federated Storage Infrastructure`.