zenon/federated-storage
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Include description of Makefile

Browse Source
This commit is contained in:
Tobias Eidelpes 2021-01-19 21:36:43 +01:00
parent ea104c0d19
commit a62229c91b
1 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -19,29 +19,36 @@
## How to start the program ## 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 * Go to `http://localhost:8080` for the frontend
* Run `docker ps` to see the container ID of the image aic_g4t2_iot_client * Run `docker ps` to see the container ID of the image aic_g4t2_iot_client
* Enter `docker exec -it <ContainerID> /bin/bash` to enter the shell of the iot_client * Enter `docker exec -it <ContainerID> /bin/bash` to get a shell of the IoT-Client
* Get a usage message by entering `help` * 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 ## Technologies used
* Python 3.8.6 with Django for the backend * Python 3.8.6 with Django for the backend
* Angular 9 for the frontend * Angular 9 for the frontend
* Dropbox API for an image storage * Dropbox API for storing images
* AWS S3 as an object storage * AWS S3 for object storage
* MongoDB as a metadata storage * MongoDB for storing metadata
## Detailed description of a usecase ## 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 Follow: [How to start the program](#How-to-start-the-program) to setup the
picture enter `trigger` into the iot_client. You can now see the pictures distributed over the program. To simulate that a device sent some picture enter `trigger` into the
different storages. Write `set 0` to position the cursor to the first image sent. Issue `update` to update the image. iot_client. You can now see the pictures distributed over the different
The new image shows up in the dashboand and a new version in the corresponding storages is created. Navigate to the Map storages. Write `set 0` to position the cursor to the first image sent. Issue
in the frontend to see a location marker where the image was taken. `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 ## 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 * Username: e01633073@student.tuwien.ac.at
* Password: aicdropboxpassword * Password: aicdropboxpassword
The relevant folder where all images are uploaded to is called `AIC Federated Storage Infrastructure`.