Skip to content

Software Onboarding Document

Jump to bottom
Aetheris743 edited this page Nov 14, 2023 · 10 revisions

The minimum to get started

Git

What is version control

Version control on wikipedia has a much larger and thorough description. For our uses it is a way that we can make sure we have known good states to go back to if we need to find the latest working build. It also means we can use github to track issues and bugs. Lastly, we can make it so that people don't push changes to the main branch and instead the only happens once another person checks that it will be a working build.

How to get started

  • Installation guide
  • Getting started guide I would strongly recommend doing the "Hello world" to "Github Flow" on a repo (repository) you create for youself to get some practice. The section on "Contributing to projects" is what we will be doing for this project
  • Fork our Repo
  • Clone your fork of our repo

Unity

  • Installation guide
  • Use Unity hub to find our unity project and install Unity 2022.3.9f1 LTS.

Docker

We have a the beginnings of the telemetry server that is a dockerized set of services. You can use docker compose to run them. Using docker compose

Code Editor

Any code editor should work, including visual studio that unity installs. If you want a different editor VSCode is relatively easy to use and integrate with unity,

NodeJS

For frontend development, install NodeJS 20.9.0

Putting it all together

  • Start Docker Services
    • Navigate to ARSIS-Telemetry-GroundControl folder in a terminal
    • run docker compose up or docker-compose up depending on if you installed the docker compose plugin or stand alone script
  • Start Unity Project
    • Use unity hub to find project folder
    • Launch project
    • Click play button
  • Check that the docker services have output showing that the api is being polled

Resources (work-in-progress)

Feel free to add anything useful

Unity:

SvelteKit:

Python:

Clone this wiki locally