From 11d101ca7e01347b389c83af0cdd9919f7565c3a Mon Sep 17 00:00:00 2001 From: Lucas Hicks Date: Sun, 15 Oct 2023 11:35:22 +1000 Subject: [PATCH 1/4] Updates readme --- build/db-handler/README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/build/db-handler/README.md b/build/db-handler/README.md index 79223bf..9a8afd9 100644 --- a/build/db-handler/README.md +++ b/build/db-handler/README.md @@ -8,22 +8,12 @@ This database handler is a web-based RESTful API microservice which is solely re ### Installation -You need a couple of dependencies if you want to run the uvicorn server locally to serve the API. Run these options: +**NOTE: These steps can be skipped if the initial install instructions have been followed on the overall build [`README`](https://github.com/lucashicks1/lambda-deco3801/tree/main/build)** -1. Install using conda environment - -For convinience, a conda environment has been created so that all project dependencies can be installed using as few commands as possible. See more on this option [here](https://github.com/lucashicks1/lambda-deco3801/blob/main/build/vision/README.md#dependencies) - -2. Install with `requirements.txt`: +If you have not setup the conda environment, run the following command: `pip install -r requirements.txt` -3. Install all dependencies individually: - -`pip install fastapi pymongo pydantic "uvicorn[standard]"` - -*Note: A python environment with every project dependency is available for use, so this step could be skipped if the other environment is set up.* - ### Database Setup This API microservice uses either a local monogbd database or a remote database hosted in the cloud. If the microservice is unable to connect to the remote instance running in the cloud, it will connect to the local database as a backup. From 846c36dc85134c01b59256157d64e96f7957b199 Mon Sep 17 00:00:00 2001 From: Lucas Hicks Date: Sun, 15 Oct 2023 11:36:30 +1000 Subject: [PATCH 2/4] Updates more readme. --- build/README.md | 22 +++++++++++++++++++++- build/figurines/README.md | 2 +- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/build/README.md b/build/README.md index 2891c9e..b8b086e 100644 --- a/build/README.md +++ b/build/README.md @@ -1,6 +1,26 @@ # BUILD Build code goes here when project underway -## Build Instructions in order of process + +## Initial Environment Setup +Our project relies on several different libraries in order for it to function. As most of our project is written in Python, there is an [`environment.yaml`](https://github.com/lucashicks1/lambda-deco3801/blob/main/environment.yaml) file that has been created, allowing you to create your own conda virtual environment. You can create and activate this environment with the following: + +``` +conda env create -f environment.yaml +conda activate lambda-env +``` +Or you can create your own environment and install the packages with + +``` +conda create -n your_env_name +conda activate your_env_name +conda install numpy pillow pytesseract matplotlib pymongo requests +conda install -c conda-forge fastapi pydantic uvicorn-standard +pip install opencv-python-headless +``` + +Once this environment is setup, all the needed dependencies for our python components should be installed. + +## Build Instructions for each project component 1. [Database](../build/db-handler/README.md) 2. [Camera](../build/vision/README.md) 3. [Display](../build/ui-display/frontend-app/README.md) diff --git a/build/figurines/README.md b/build/figurines/README.md index 6c297b7..a8ae10f 100644 --- a/build/figurines/README.md +++ b/build/figurines/README.md @@ -1,5 +1,5 @@ # Microcontroller Communications 1. Connect the Seeduino Xiao to a serial port using provided USB-C to USB-A cable -2. Double click the .bat file located in this directory +2. Double click the [`microcontroller_communications.bat`](https://github.com/lucashicks1/lambda-deco3801/blob/main/build/figurines/microcontroller_communications.bat) file located in this directory 3. The file will download all required python libraries, so please wait for it to finish 4. The program will run on completion of installations \ No newline at end of file From a6c54242cc7c5799d5870ea4d14a1f97cd9b7c3d Mon Sep 17 00:00:00 2001 From: Lucas Hicks Date: Sun, 15 Oct 2023 11:37:46 +1000 Subject: [PATCH 3/4] Updates more readme. --- build/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/build/README.md b/build/README.md index b8b086e..a234622 100644 --- a/build/README.md +++ b/build/README.md @@ -1,5 +1,5 @@ -# BUILD -Build code goes here when project underway +# Build guide +Please follow these instructions to run the project. ## Initial Environment Setup Our project relies on several different libraries in order for it to function. As most of our project is written in Python, there is an [`environment.yaml`](https://github.com/lucashicks1/lambda-deco3801/blob/main/environment.yaml) file that has been created, allowing you to create your own conda virtual environment. You can create and activate this environment with the following: From 7534e3077a5725cf2b4b20627254cf6f08283b95 Mon Sep 17 00:00:00 2001 From: Lucas Hicks Date: Sun, 15 Oct 2023 11:50:43 +1000 Subject: [PATCH 4/4] Updates more readme. --- build/README.md | 4 ++-- build/db-handler/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/build/README.md b/build/README.md index a234622..6c0a54e 100644 --- a/build/README.md +++ b/build/README.md @@ -21,8 +21,8 @@ pip install opencv-python-headless Once this environment is setup, all the needed dependencies for our python components should be installed. ## Build Instructions for each project component -1. [Database](../build/db-handler/README.md) -2. [Camera](../build/vision/README.md) +1. [Database Handler](../build/db-handler/README.md) +2. [Image Recognition](../build/vision/README.md) 3. [Display](../build/ui-display/frontend-app/README.md) 4. [Microcontroller](../build/microcontroller/README.md) 5. [Microcontroller Communication](../build/figurines/README.md) diff --git a/build/db-handler/README.md b/build/db-handler/README.md index 9a8afd9..98a9800 100644 --- a/build/db-handler/README.md +++ b/build/db-handler/README.md @@ -1,4 +1,4 @@ -# Database handler +# Database Handler ## Overview