Skip to content

Commit bd18e64

Browse files
committed
Update README with frontend development instructions
1 parent 4170d9e commit bd18e64

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,24 @@ Then, click `Start` to begin a session. Select the `OBC-firmware.out` executable
284284

285285
We use Code Composer Studio for debugging the firmware. **TODO**: Write a tutorial on how to use CCS.
286286

287+
### **Frontend Development**
288+
289+
To run the frontend, you will need Deno 2 installed which was installed in the pre-commit setup instructions above.
290+
291+
#### **Running the ARO Frontend**
292+
293+
```sh
294+
cd gs/frontend/aro # Assuming you are in the top-level directory
295+
deno task dev # This will start the frontend on localhost:5173
296+
```
297+
298+
#### **Running the MCC Frontend**
299+
300+
```sh
301+
cd gs/frontend/mcc # Assuming you are in the top-level directory
302+
deno task dev # This will start the frontend on localhost:5173
303+
```
304+
287305
## Contributing
288306

289307
1. Make sure you're added as a member to the UW Orbital organization on GitHub.
@@ -432,6 +450,7 @@ File comments are not required
432450
class PointTwoDimension:
433451
"""
434452
@brief Class for storing a 2D point
453+
435454
@attribute x (int) - x coordinate of the point
436455
@attribute y (int) - y coordinate of the point
437456
"""
@@ -440,7 +459,7 @@ class PointTwoDimension:
440459
self.x = x
441460
self.y = y
442461

443-
@dataclasses.dataclass
462+
@dataclass
444463
class PointTwoDimension:
445464
"""
446465
@brief Class for storing a 2D point
@@ -453,10 +472,10 @@ class PointTwoDimension:
453472
```
454473

455474
```python
456-
import enum
475+
from enum import Enum
457476

458477
# No comments required
459-
class ErrorCode(enum.Enum):
478+
class ErrorCode(Enum):
460479
"""
461480
@brief Enum for the error codes
462481
"""
@@ -476,9 +495,9 @@ class ErrorCode(enum.Enum):
476495

477496
```python
478497
# For brevity, the class comments were removed but they should be in real code
479-
import dataclasses
498+
from dataclasses import dataclass
480499

481-
@dataclasses.dataclass
500+
@dataclass
482501
class PointTwoDimension:
483502
x: int
484503
y: int
@@ -492,9 +511,9 @@ class ErrorCode(enum.Enum):
492511
- `EnumName` in PascalCase
493512

494513
```python
495-
import enum
514+
from enum import Enum
496515

497-
class ErrorCode(enum.Enum):
516+
class ErrorCode(Enum):
498517
SUCCESS = 0
499518
INVALID_ARG = 1
500519

0 commit comments

Comments
 (0)