Skip to content

Commit 6529170

Browse files
committed
Create initial setup guide and database setup page
1 parent c47fefc commit 6529170

File tree

7 files changed

+79
-17
lines changed

7 files changed

+79
-17
lines changed

docs/src/content/docs/builds/build-gs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The `cmake --build .` takes some time to run since it is using a single thread t
2626
:::
2727

2828
## Setting up frontend development
29-
To run the frontend, Deno 2 must be installed. If it isn't, see [Initial setup](/OBC-firmware/start-here/setup/) and follow it to set up the database as well.
29+
To run the frontend, Deno must be installed. If it isn't, see [Initial setup](/OBC-firmware/start-here/setup/) and follow it to set up the database as well.
3030

3131
Run all commands from the root directory.
3232

docs/src/content/docs/builds/build-obc.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following is a simple guide for building the app for the OBC and flashing.
1818
cmake --build .
1919
```
2020

21-
:::tip[Tip: Reducing Build Time]{icon="setting"}
21+
:::tip[Tip: Reducing build time]{icon="setting"}
2222
The `cmake --build .` takes some time to run since it is using a single thread to compile. To speed up the process we can replace it with one of the following commands:
2323
1. `make -j 16` (Recommended for most systems)
2424
2. `make -j 32` (This is faster but depends on if your system can handle 32 parallel jobs)
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Database setup
3+
description: Database setup for your development workflow
4+
sidebar:
5+
order: 3
6+
badge:
7+
text: WIP
8+
variant: caution
9+
---

docs/src/content/docs/start-here/file-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
badge:
66
text: WIP
77
variant: caution
8-
order: 4
8+
order: 5
99
---
1010
import { FileTree } from '@astrojs/starlight/components';
1111

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Initial setup
3+
description: Initial setup for your development workflow
4+
sidebar:
5+
order: 2
6+
badge:
7+
text: WIP
8+
variant: caution
9+
---
10+
import { Steps } from '@astrojs/starlight/components';
11+
12+
This guide walks you through the process of setting up your development environment.
13+
14+
## Windows
15+
:::caution[]
16+
**Windows is not supported for firmware and ground station development.**
17+
18+
If you are using Windows, you will need to install Windows Subsystem for Linux (WSL). WSL lets you run a complete Linux environment directly inside Windows without virtual machine overhead or dual booting.
19+
20+
After installing WSL, continue to the [Linux/WSL](#linuxwsl) section of the guide.
21+
:::
22+
23+
### WSL installation
24+
25+
Follow Microsoft's official guide to install WSL: https://learn.microsoft.com/en-us/windows/wsl/install. Make sure you install the latest Ubuntu distribution for consistency (this should be the default). You can use another distribution, but note that some steps may differ, most notably package installation.
26+
27+
## Linux/WSL
28+
29+
<Steps>
30+
1. Open a terminal and run the following commands to install our required tools:
31+
32+
```shell
33+
sudo apt update
34+
sudo apt install -y build-essential gcc-multilib g++-multilib cmake curl
35+
```
36+
37+
2. Install Python 3.11+ and pip. If you are using Ubuntu 24.04 LTS and up or installed the default distribution of WSL, you should already have a sufficient version of Python installed. Check your installed version with:
38+
39+
```shell
40+
python3 --version
41+
```
42+
If it is 3.11 or higher, you're good.
43+
44+
3. Install the Python virtual environment:
45+
46+
```shell
47+
sudo apt install python3-venv
48+
```
49+
50+
4. Setup your virtual environment by running the following commands in the repository's root directory:
51+
52+
```shell
53+
python3 -m venv .venv
54+
source .venv/bin/activate
55+
pip install -r requirements.txt
56+
pip install -e .
57+
58+
5. Setup pre-commit:
59+
60+
```shell
61+
curl -fsSL https://deno.land/install.sh | sh
62+
pre-commit install
63+
```
64+
65+
6. Finally, setup the PostgreSQL database with the [Database setup](/OBC-firmware/start-here/database-setup) guide.
66+
</Steps>

docs/src/content/docs/start-here/setup.mdx

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/src/content/docs/start-here/style-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Style guide
33
description: Style guide for all firmware and ground station code
44
sidebar:
5-
order: 3
5+
order: 4
66
---
77

88
This style guide outlines our team standards for writing firmware and ground station code.

0 commit comments

Comments
 (0)