Skip to content

Getting Started

Cloning the repository

For Windows users, use WSL for the following instructions. If you don't have WSL, you can follow the instructions here to install it.

Send your GitHub username to the team lead, and they will add you to the repository. Then, ensure you have git installed. If not, install it from here.

To be able to clone the repository, you will have to setup SSH keys:

ssh-keygen # Hit enter on all prompts

Retrieve the public key:

cat ~/.ssh/id_rsa.pub

Add this public key to your GitHub account. Instructions can be found here.

Now you are ready to clone the repository:

git clone git@github.com:PurdueAerialRoboticsTeam/feonix.git

Methods

There are three methods to set up the repository:

  1. Using Nix (recommended)
  2. Using Devcontainers (quickest but has some limitations)
  3. Manually (not recommended)

Using Nix

Nix Prerequisites

  • A Unix-like operating system (Linux, macOS, etc.), or WSL on Windows.
  • Nix
  • direnv (optional, but recommended)

Additional VSCode Extensions

Installing Nix

To install Nix, you will need to run the following command:

curl --proto '=https' --tlsv1.2 -sSf -L \
  https://install.determinate.systems/nix | \
  sh -s -- install --determinate

Now enter the repository and enter the development environment:

cd feonix # or the directory where you cloned the repository

# Enter the nix shell (if using direnv, this will be done automatically):
nix develop

Using Devcontainers

Devcontainers Prerequisites

  1. Install Docker. On Windows, you will need to install WSL first. Instructions can be found here.

  2. Install Visual Studio Code and the Remote - Containers extension.

Devcontainers Setup

  1. Open the repository in Visual Studio Code.
  2. Press F1 (Open Command Palette) and select Dev Containers: Rebuild and Reopen in Container.

Manually

I'll add instructions here later.

Note: This is a work in progress. If you want to help, please contact the team lead.