Skip to content

Contributing - Environment Setup

This page assumes you're already a little familiar with Git, VS Code, and programming in general.

You do not need to be an expert, but you should know how to clone a repo, open a project in VS Code, and install basic tools. Each section below briefly explains how to set up your environment for the different parts of the FIRM ecosystem.

💡 Firmware Development

This is for contributors who want to work on the embedded firmware that runs on the FIRM device itself, written in C.

Follow the setup instructions from the main FIRM repo:
https://github.com/NCSU-High-Powered-Rocketry-Club/FIRM

🖥️ FIRM Client Development

The FIRM Client handles parsing live FIRM data and packing it into an easy-to-use format. Its core is written in Rust, with libraries for Python, JavaScript/TypeScript, and (eventually) Arduino.

Follow the setup instructions from the FIRM Client repo:
https://github.com/NCSU-High-Powered-Rocketry-Club/FIRM-Client

🌐 Web App Development

The FIRM Web App lets users configure the device and view live data directly in the browser. It's written in TypeScript and uses React and Tailwind CSS.

Follow the setup instructions from the FIRM Web App repo: https://github.com/NCSU-High-Powered-Rocketry-Club/FIRM-Web-App

If you're unsure which area to start with, look at each repo's Issues page to see what's currently being worked on, and what you think you can help with/would be interested in.