From b892b73f4b64fc805acb9e277630d49a3a57c759 Mon Sep 17 00:00:00 2001 From: Eshan Betrabet Date: Tue, 30 Jan 2024 18:50:13 -0500 Subject: [PATCH 1/2] Update readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8df98ba..782e031 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Visualizes real-time telemetry data from the CUInSpace rocket. Telemetry data is over websocket as JSON to the frontend. ## Dashboard Preview -![Dashboard Preview](./docs/dashboard.png) +![Dashboard Preview](./docs/dashboard.png) (outdated image but it looks similar) ## Overview @@ -39,6 +39,21 @@ maintain a static display of the most recently received data when connection bec - ReactJS - NodeJS - Python (backend) +## Libraries +- [Visx](https://airbnb.io/visx/) +- [React LeafletJS](https://react-leaflet.js.org/) +- [React Grid Layout](https://github.com/react-grid-layout/react-grid-layout) +## Installation + +Install ground-station-ui with npm + +```bash + git clone https://github.com/CarletonURocketry/ground-station-ui.git + cd ground-station-ui + npm install + npm run start +``` + ## Documentation Please visit [the repository's wiki](https://github.com/CarletonURocketry/ground-station-ui/wiki) to view the documentation for this project. From 40665994daa87e2ef940c0ebd356511766e56777 Mon Sep 17 00:00:00 2001 From: Eshan Betrabet Date: Tue, 30 Jan 2024 18:55:42 -0500 Subject: [PATCH 2/2] Add link to ground-station backend --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 782e031..46efc3c 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ maintain a static display of the most recently received data when connection bec - [React LeafletJS](https://react-leaflet.js.org/) - [React Grid Layout](https://github.com/react-grid-layout/react-grid-layout) ## Installation - +https://github.com/CarletonURocketry/ground-station Install ground-station-ui with npm ```bash @@ -54,6 +54,7 @@ Install ground-station-ui with npm npm run start ``` +>[ground-station](https://github.com/CarletonURocketry/ground-station) is required to visualize replays ## Documentation Please visit [the repository's wiki](https://github.com/CarletonURocketry/ground-station-ui/wiki) to view the documentation for this project.