Skip to content

Commit

Permalink
Merge pull request #42 from CarletonURocketry/39-update-ground-statio…
Browse files Browse the repository at this point in the history
…n-ui-readme

Update readme
  • Loading branch information
linguini1 authored Jan 31, 2024
2 parents 6aeca47 + 4066599 commit 929825f
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -39,6 +39,22 @@ 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
https://github.com/CarletonURocketry/ground-station
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
```

>[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.
Expand Down

0 comments on commit 929825f

Please sign in to comment.