You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/builds/build-gs.mdx
+20-18Lines changed: 20 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,30 +23,32 @@ The `cmake --build .` takes some time to run since it is using a single thread t
23
23
:::
24
24
25
25
## Setting up frontend development
26
-
To run the frontend, Deno must be installed. If it isn't, see [Initial setup](/OBC-firmware/start-here/initial-setup/) and follow it to set up the database as well.
27
-
28
-
Run all commands from the root directory.
29
-
30
-
:::note
31
-
If you have issues running any Deno commands, try restarting your shell after installing Deno.
32
-
:::
33
-
34
-
35
-
### Installing the frontend
36
-
```shell
37
-
cd gs/frontend
38
-
deno install --frozen
39
-
```
26
+
To run the frontend, Node.js must be installed. If it isn't, see [Initial setup](/OBC-firmware/start-here/initial-setup/) and follow it to set up the database as well.
40
27
41
28
### Running the ARO frontend
42
-
This will start the frontend at `localhost:5173`.
29
+
While in the root directory, run the following commands to start the ARO frontend:
43
30
```shell
44
31
cd gs/frontend/aro
45
-
deno task dev
32
+
npm install
33
+
npm run dev
46
34
```
35
+
If you have Docker installed, you can instead run the following command:
36
+
```shell
37
+
docker compose up aro-frontend
38
+
```
39
+
40
+
After you install new dependencies, you will need to rebuild the container with `docker-compose up --build aro-frontend`.
41
+
47
42
### Running the MCC frontend
48
-
This will start the frontend at `localhost:5173`.
43
+
While in the root directory, run the following commands to start the MCC frontend:
49
44
```shell
50
45
cd gs/frontend/mcc
51
-
deno task dev
46
+
npm install
47
+
npm run dev
52
48
```
49
+
If you have Docker installed, you can instead run the following command:
50
+
```shell
51
+
docker compose up mcc-frontend
52
+
```
53
+
54
+
After you install new dependencies, you will need to rebuild the container with `docker-compose up --build mcc-frontend`.
Copy file name to clipboardExpand all lines: docs/src/content/docs/builds/build-obc.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,6 @@ The following is a simple guide on building the app for the OBC.
25
25
3. There are also plenty of extra options that you can use besides `-DCMAKE_BUILD_TYPE` by appending them to the `cmake ..` command. Take a look at the [CMake options guide](/OBC-firmware/builds/cmake-options/).
26
26
27
27
:::caution
28
-
Make sure to specify the `-DBOARD_TYPE=` option to avoid any unwanted behavior
28
+
Make sure to specify the `-DBOARD_TYPE=` option to avoid any unwanted behaviour.
Copy file name to clipboardExpand all lines: docs/src/content/docs/start-here/initial-setup.mdx
+29-7Lines changed: 29 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,8 +26,15 @@ For command-line work, it's recommended to use **Windows Terminal** (in Windows,
26
26
27
27
You can also work with WSL in VS Code. To open VS Code in WSL, install the WSL extension, then either run `code .` from a WSL directory or use the Remote Explorer in VS Code.
28
28
:::
29
+
30
+
:::caution
31
+
Clone the repository and do all work in the Linux home directory (e.g. `~/projects/OBC-firmware`). Don't store your code on Windows and access it via the `mnt` directory. This will help with performance and compatibility.
32
+
:::
33
+
29
34
## Linux/WSL
30
35
36
+
### Standard setup
37
+
31
38
<Steps>
32
39
1. Ensure you have Git installed. If you are using Ubuntu 24.04 LTS or later, or installed the default WSL distribution, you should already have it installed.
33
40
If not, open a terminal and run the following commands to install Git:
@@ -75,17 +82,32 @@ If not, open a terminal and run the following commands to install Git:
75
82
pip install -r requirements.txt
76
83
pip install -e .
77
84
78
-
7. Setup the pre-commit by running the following commandsin the repository's root directory. You may need to install `unzip` in order to install Deno. If you do not have `unzip`, run `sudo apt install unzip`.
85
+
7. Setup the pre-commit by running the following commandin the repository's root directory:
79
86
80
87
```shell
81
-
# The first command installs Deno, which is required for our pre-commit
82
-
curl -fsSL https://deno.land/install.sh | sh
83
88
pre-commit install
84
89
```
85
90
86
-
8.
87
-
:::note[Ground station only]
88
-
Set up the PostgreSQL database with the [Database setup](/OBC-firmware/start-here/database-setup) guide.
89
-
:::
91
+
</Steps>
92
+
93
+
### Ground station (optional)
94
+
If you'll also be working on the ground station, complete these extra steps:
0 commit comments