A simple local image collector using a local-backed MongoDB instance and implemented asynchronously using Python Tornado and Docker. This web app is developed with additional html code for more client-friendly support. You can also test this collector using an API Platform, such as Postman. For any inquiries, refer to the instructions below.
The master branch is the most up-to-date one and should be the only one used for testing and using.
- Clone this repository
- Make sure that you have Docker and Docker Compose installed
- Run
docker compose up -dto build the app
Disclaimer: the instructions may vary based on the app you use. I use Postman to test the API, so variations may happen if you use another app
- Download the API testing app to your choosing
- To test uploading images:
- In the target URL bar: type "http://localhost:8888/api" (no slash / at the end)
- Choose POST as the API request type
- In the request body, choose form-data type. Put "image" (no double quotes) as key (don't forget to switch the upload type to file) and upload the image into the value box
- If successful, the request will return a UUID. Refer to this UUID to retrieve your image
- To test downloading images using the UUID:
- In the target URL bar: type "http://localhost:8888/api/{UUID}" where UUID is the UUID of the photo (discard the curly brackets when type in the uuid)
- Choose GET as the API request type
- Make sure the request body is set as "none"
- Click send to send the request. If successful, the result image will be display in the result box
- Navigate to "http://localhost:8888/"
- Follow the instructions on the menu to upload and download images.