Merge pull request #20 from UNSW-Redback-Racing/25T3-updates

25T3 TA Updates

Author: CullanAriyawanse

README.md

@@ -1,16 +1,16 @@
 ![daq_ta_banner](https://github.com/UNSW-Redback-Racing/DAQ-Technical-Assessment/assets/38149391/9893b793-21ac-4b30-a48f-e26003763460)
 
-# UNSW Redback Racing | Data Acquisition Technical Assessment 2025 T1
+# UNSW Redback Racing | Data Acquisition Technical Assessment 2025 T3
 
 This assessment aims to gauge your current technical ability and give you a practical introduction to some of what we do here at Redback Racing. We don't expect everyone to complete everything perfectly - you may not be familiar with all the frameworks and tools mentioned here, and so you may find it helpful to consult the resources linked, as well as doing your own research.
 
 We also highly encourage you to read through the code and try to understand how it currently works, as well as reading the terminal output of the code once you get it running.
 
 **Please ensure you note down your approaches, thoughts and research in the [brainstorming.md](./brainstorming.md) file.**
 
-If you have any questions/require clarification about the spec, direct them to the [#daq-ta-questions](https://discord.com/channels/884232338316345374/1144840015856291890) channel within the [UNSW Redback Racing Discord](https://discord.gg/7RT4qewZ) server.
+If you have any questions/require clarification about the spec, direct them to the [#daq-ta-questions](https://discord.gg/xm3GvxdD) channel within the [UNSW Redback Racing Discord](https://discord.gg/KYNk9X65) server.
 
-### Submission Due Date: 11:59PM 15/03/2025
+### Submission Due Date: 11:59PM 06/09/2025
 
 ## Prerequisites
 
@@ -40,4 +40,4 @@ Please refer to the `docs/README.md` file within each theme directory to find re
 
 ## Submission
 
-Complete the submission form [here](https://forms.office.com/r/NPkBJZwVzG)
+Complete the submission form [here](https://forms.office.com/r/mk2AeZeTWr)

spyder/docs/README.md

@@ -66,13 +66,11 @@ To do this:
 
 **Additionally, it is assumed that your solution to each answer is justified within the `brainstorming.md` file. You may write as much content as you see fit for each question.**
 
-1. Since the `ui` service operates within a docker container, any code changes that you make will not be immediately reflected until you rebuild the containers. [nodemon](https://www.npmjs.com/package/nodemon) is a package which will help reflect any changes you make immediately by automatically restarting the node application when any file is changed. Your task is to install and configure the **nodemon** npm package into the `ui` directory.
+1. When running the emulator, the client will occasionally recieve values in the incorrect format. This will be visible in the output of `streaming service` as well as the `ui`. Think about what is happening, and write additional code in `streaming-service` that prevents 'invalid' data from being sent to the frontend. What you wish to do with 'invalid' data is up to you, so long as it is justified in `brainstorming.md`.
 
-2. When running the emulator, the client will occasionally recieve values in the incorrect format. This will be visible in the output of `streaming service` as well as the `ui`. Think about what is happening, and write additional code in `streaming-service` that prevents 'invalid' data from being sent to the frontend. What you wish to do with 'invalid' data is up to you, so long as it is justified in `brainstorming.md`.
+2. A safe operating range for the battery temperature is 20-80 degrees. Add a feature to the backend `streaming-service` so that each time the received battery temperature exceeds this range more than 3 times in 5 seconds, the current timestamp and a simple error message is printed to console.
 
-3. A safe operating range for the battery temperature is 20-80 degrees. Add a feature to the backend `streaming-service` so that each time the received battery temperature exceeds this range more than 3 times in 5 seconds, the current timestamp and a simple error message is printed to console.
-
-4. Currently the connect/disconnect button in the top right corner of the ui (frontend) does not update when data is streamed in via streaming service. Why is this occurring and what can be done to rectify this?
+3. Currently the connect/disconnect button in the top right corner of the ui (frontend) does not update when data is streamed in via streaming service. Why is this occurring and what can be done to rectify this?
 
 - **Tip:** To start/stop emulating data, you can start/stop the individual data-emulator docker container
   - To see a list of all running docker containers
@@ -88,7 +86,7 @@ To do this:
     docker start spyder-data-emulator-1
     ```  
 
-5. The NextJS frontend is currently very basic. **Using primarily tailwindCSS and Shadcn/ui components**, extend the frontend by completing the following:
+4. The NextJS frontend is currently very basic. **Using primarily tailwindCSS and Shadcn/ui components**, extend the frontend by completing the following:
 
 - Ensure the data displayed from `streaming-service` is correct to **3 decimal places** instead of being unbounded as it is currently.
 - Ensure the battery temperature value changes colours based on the current temperature (E.g. changing to red when the safe temperature range is exceeded).
@@ -104,7 +102,7 @@ To do this:
   - You may use components other than those mentioned above if they can be justified in your `brainstorming.md` file (E.g. additional charting libraries, notifications (toast) libraries etc).
   - You are free to make more than three additional features if you're feeling creative!
 
-6. **Optional Task** - Within the `ui` repository is a file named `page.tsx`. You should be familiar with this file from previous steps. You are tasked with seperating the **websocket** code from `page.tsx` into a new file called `data-wrapper.tsx`. This should contain any code that handles the storage/acquisition of data from streaming service. The file `data-wrapper.tsx` should contain a react context that wraps `numeric.tsx` and any other components that display data.
+5. **Optional Task** - Within the `ui` repository is a file named `page.tsx`. You should be familiar with this file from previous steps. You are tasked with seperating the **websocket** code from `page.tsx` into a new file called `data-wrapper.tsx`. This should contain any code that handles the storage/acquisition of data from streaming service. The file `data-wrapper.tsx` should contain a react context that wraps `numeric.tsx` and any other components that display data.
 - To use the data stored in this file, you will need to create a context hook using createContext/useContext.
 - The following is a brief introduction into creating a react context and the benefits/reasons for doing so:
 https://www.w3schools.com/react/react_usecontext.asp  
@@ -122,6 +120,8 @@ To see the ui, go to [http://localhost:3000](http://localhost:3000) in your brow
 
 ### Additional Notes
 
-- In order to use this command you will have to install **Docker Desktop** in Windows or **Docker** in the terminal locally depending on how your system is configured. 
+- In order to use this command you will have to install [**Docker Desktop**](https://docs.docker.com/get-started/introduction/get-docker-desktop/) for Windows/Mac/Linux or [**Docker Engine**](https://docs.docker.com/engine/install/) for Linux in the terminal locally depending on how your system is configured.
+  - Running `docker compose up` the first time may take awhile which is completely ok because Docker needs to pull images and build services from scratch. Subsequent runs of `docker compose up` shouldn't take nearly as long since Docker reuses cached layers and existing containers.
 - If you happen to install any new packages, you will need to run `docker compose up --build`.
   - To simplify, the reason for this is because the telemetry system runs in a containerised environment where the packages are only installed upon the containers first build. So once the containers are created (with `docker compose up`), should there be any package changes, the containers must be rebuilt (denoted by the `--build` flag) for the new packages to be installed.
+- If you get stuck on a question, feel free to skip it and come back to it at the end or completely skip it overall. You do not have to complete each task sequentially.

spyder/ui/Dockerfile

@@ -8,4 +8,4 @@ RUN npm run build
 
 EXPOSE 3000
 
-CMD ["npm", "start"]
+CMD ["npm", "run", "dev"]