Merge branch 'main' into Formatting-Backend

Author: Yarik-Popov

.github/workflows/frontend_build.yml

@@ -0,0 +1,25 @@
+name: Frontend Build
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        project: ['aro', 'mcc']
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v2
+        with:
+          deno-version: v2.x
+      - name: Install dependencies for ${{matrix.project}}
+        run: |
+          cd ./gs/frontend/${{matrix.project}}
+          deno install
+      - name: Build ${{matrix.project}}
+        run: |
+          cd ./gs/frontend/${{matrix.project}}
+          deno task build

.github/workflows/pre-commit.yml

@@ -13,6 +13,9 @@ jobs:
     - uses: actions/setup-python@v3
       with:
         python-version: '3.10'
+    - uses: denoland/setup-deno@v2
+      with:
+        deno-version: v2.x
     - id: file_changes
       uses: trilom/file-changes-action@v1.2.4
       with:

.gitignore

@@ -56,6 +56,11 @@ dkms.conf
 .idea/
 compile_commands.json
 .cache/
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
 
 .env
 
@@ -74,3 +79,23 @@ __pycache__/
 *.coverage
 .mypy_cache/
 .ruff_cache/
+
+# Frontend Dependencies
+*node_modules
+*.pnp
+.pnp.js
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Frontend build
+*dist
+*dist-ssr
+*.local
+*.vite

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
     - id: trailing-whitespace
       exclude: '(libs|hal)/.*'
     - id: end-of-file-fixer
-      exclude: '(libs|hal)/.*'
+      exclude: '((libs|hal)/.*|\.(ts|tsx|css|html|json|md|yaml|yml|ipynb)$)'
     - id: check-added-large-files
       exclude: '(libs|hal)/.*'
 -   repo: https://github.com/pre-commit/mirrors-clang-format
@@ -22,3 +22,7 @@ repos:
     - id: ruff
       args: ["--fix"]
     - id: ruff-format
+-   repo: https://github.com/nozaq/pre-commit-deno
+    rev: 0.1.0
+    hooks:
+    -   id: deno-fmt

CMakeLists.txt

@@ -37,7 +37,7 @@ endif()
 if(${CMAKE_BUILD_TYPE} MATCHES GS)
     set (CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
     enable_language(C CXX)
-    add_subdirectory(gs)
+    add_subdirectory(gs/backend)
     add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/libs/cserialport)
 endif()
 

README.md

@@ -9,6 +9,7 @@ This repository holds all the code written by UW Orbital's firmware team. This i
 - [C Style Guide](#c-style-guide)
 - [Python Style Guide](#python-style-guide)
 - [Pytest Style Guide](#pytest-style-guide)
+- [Typescript/React Style Guide](#typescript/react-style-guide)
 - [Authors](#authors)
 
 **[Back to top](#table-of-contents)**
@@ -23,7 +24,7 @@ This section will explain how to set up the repo, and how to build, flash, and d
 2. To clone this project, run the following command in whatever directory you want to store the repository in:
 
 ```
-git clone git@github.com:UWOrbital/OBC-firmware.git
+git clone https://github.com/UWOrbital/OBC-firmware.git
 ```
 
 ### Dependencies
@@ -63,11 +64,11 @@ Once you open the docker instance, open a terminal in VSCode and run the followi
 This command opens a terminal in VSCode: `` Ctrl + Shift + `  ``
 
 Enter these commands in your terminal:
-
-```
+```sh
 sudo apt-get update
-sudo apt-get install -y python3-pip build-essential cmake gcc-multilib g++-multilib
+sudo apt-get install -y python3-pip build-essential cmake gcc-multilib g++-multilib curl
 pip3 install -r requirements.txt
+curl -fsSL https://deno.land/install.sh | sh # Deno is required for pre-commit
 pre-commit install
 ```
 
@@ -88,7 +89,7 @@ Skip this section if you set up a Docker development environment.
 2. In WSL2, run the following:
    ```sh
    sudo apt-get update
-   sudo apt-get install build-essential gcc-multilib g++-multilib
+   sudo apt-get install build-essential gcc-multilib g++-multilib curl
    ```
 3. Choose the environment where you'll be running `git commit` (either WSL2 or the host) and install Python 3.10 and pip. (Only required for Python devs)
    A. If using WSL, follow the instructions under the `Linux` section 2.
@@ -107,6 +108,7 @@ Skip this section if you set up a Docker development environment.
 4. Setup pre-commit.
    In the WSL, under the OBC-firmware directory, run the following commands:
    ```sh
+   curl -fsSL https://deno.land/install.sh | sh # Deno is required for pre-commit
    pip install -r requirements.txt # You may want to create a Python virtual env before this if you haven't already
    pre-commit install
    ```
@@ -129,7 +131,7 @@ brew install make
 brew install gcc
 ```
 
-2. Install Python 3.10 and setup Python virtual environment (Only required for Python devs)
+2. Install Python 3.10 and setup Python virtual environment (Only required for Backend devs)
 
 Run the following commands in the OBC-firmware directory:
 
@@ -144,6 +146,7 @@ pip install -e .
 3. Setup pre-commit
 
 ```sh
+curl -fsSL https://deno.land/install.sh | sh # Deno is required for pre-commit
 pip install -r requirements.txt # You may want to create a Python virtual env before this if you haven't already
 pre-commit install
 ```
@@ -156,10 +159,10 @@ Skip this section if you set up a Docker development environment.
 
 ```sh
 sudo apt-get update
-sudo apt-get install build-essential gcc-multilib g++-multilib
+sudo apt-get install build-essential gcc-multilib g++-multilib curl
 ```
 
-2. Install Python 3.10 and setup Python virtual environment (Only required for Python devs)
+2. Install Python 3.10 and setup Python virtual environment (Only required for Backend devs)
 
 Run the following commands in the OBC-firmware directory:
 
@@ -174,6 +177,7 @@ pip install -e .
 3. Setup pre-commit
 
 ```sh
+curl -fsSL https://deno.land/install.sh | sh # Deno is required for pre-commit
 pip install -r requirements.txt # You may want to create a Python virtual env before this if you haven't already
 pre-commit install
 ```
@@ -280,6 +284,24 @@ Then, click `Start` to begin a session. Select the `OBC-firmware.out` executable
 
 We use Code Composer Studio for debugging the firmware. **TODO**: Write a tutorial on how to use CCS.
 
+### **Frontend Development**
+
+To run the frontend, you will need Deno 2 installed which was installed in the pre-commit setup instructions above.
+
+#### **Running the ARO Frontend**
+
+```sh
+cd gs/frontend/aro # Assuming you are in the top-level directory
+deno task dev # This will start the frontend on localhost:5173
+```
+
+#### **Running the MCC Frontend**
+
+```sh
+cd gs/frontend/mcc # Assuming you are in the top-level directory
+deno task dev # This will start the frontend on localhost:5173
+```
+
 ## Contributing
 
 1. Make sure you're added as a member to the UW Orbital organization on GitHub.
@@ -428,6 +450,7 @@ File comments are not required
 class PointTwoDimension:
 	"""
 	@brief Class for storing a 2D point
+
 	@attribute x (int) - x coordinate of the point
 	@attribute y (int) - y coordinate of the point
 	"""
@@ -436,7 +459,7 @@ class PointTwoDimension:
 		self.x = x
 		self.y = y
 
-@dataclasses.dataclass
+@dataclass
 class PointTwoDimension:
 	"""
 	@brief Class for storing a 2D point
@@ -449,10 +472,10 @@ class PointTwoDimension:
 ```
 
 ```python
-import enum
+from enum import Enum
 
 # No comments required
-class ErrorCode(enum.Enum):
+class ErrorCode(Enum):
    """
    @brief Enum for the error codes
    """
@@ -472,9 +495,9 @@ class ErrorCode(enum.Enum):
 
   ```python
   # For brevity, the class comments were removed but they should be in real code
-  import dataclasses
+  from dataclasses import dataclass
 
-  @dataclasses.dataclass
+  @dataclass
   class PointTwoDimension:
   	x: int
   	y: int
@@ -488,9 +511,9 @@ class ErrorCode(enum.Enum):
 - `EnumName` in PascalCase
 
   ```python
-  import enum
+  from enum import Enum
 
-  class ErrorCode(enum.Enum):
+  class ErrorCode(Enum):
   	SUCCESS = 0
   	INVALID_ARG = 1
 
@@ -508,21 +531,21 @@ Handled by pre-commit
 #### Notes about imports
 
 - Imports should only be used at the top of the file (no function or scoped imports)
-- Only modules should be imported
+- Modules should not be imported
 
 ```python
 # module1 contains very_long_module_name and function foo and variable var.
 #   very_long_module_name contains bar
 
-# Yes:
-from module1 import very_long_module_name as module2  # Casting to shorter name
+# No:
+from module1 import very_long_module_name as module2
 import module1
 
 module1.foo()
 module1.var
 module2.bar()
 
-# No:
+# Yes:
 from module1.very_long_module_name import bar
 from module1 import foo, var
 
@@ -547,6 +570,44 @@ bar()
 
 **[Back to top](#table-of-contents)**
 
+## Typescript/React Style Guide
+
+### Comments
+
+#### Single Line Comments
+
+Variable and function names should be descriptive enough to understand even without comments. Comments are needed to describe any complicated logic. You may use `//` or `/* */` for single line comments.
+
+#### Function Comments
+
+Function comments should follow the format shown below:
+```typescript
+/**
+ * @brief Adds two numbers together
+ *
+ * @param num1 - The first number to add.
+ * @param num2 - The second number to add.
+ * @return Returns the sum of the two numbers.
+ */
+function addNumbers(num1: number, num2: number): number {
+  return num1 + num2;
+}
+```
+
+#### File Comments
+
+- File comments are not required
+
+### ****Naming and typing conventions****
+
+-   `variableNames` in camelCase
+-   `functionNames()` in camelCase
+-   `CONSTANT_NAME` in CAPITAL_SNAKE_CASE
+-   `file_names` in snake_case
+-   `ClassName` and `ComponentName` in PascalCase
+
+**[Back to top](#table-of-contents)**
+
 ## Authors
 
 This codebase was developed by the members of UW Orbital, the University of Waterloo's CubeSat design team.

deno.json

@@ -0,0 +1,5 @@
+{
+  "fmt": {
+    "include": ["gs/frontend/"]
+  }
+}