stratos_ground-station

README

Stratos - Ground Station

TODO: describe the project

Contributing

Requirements

The following languages and dependencies need to be installed to be able to run and build the project.

• Go / Golang (min version: v1.16)
  ^{Run go version to get your current version}
• Docker ^{_(optional)
  Only required to cross-compile (see build)}
• NodeJS
• Wails

Run

To run the program in development mode:

1. Open a terminal in the project root directory.
2. Start the backend: wails serve
3. Open a second terminal in the project root directory.
4. Move to the frontend directory: cd ./frontend
5. Start the frontend: npm run serve
6. Wait for the application to be ready.
   
7. Open a browser and go to localhost:8080.

Build

For your OS

To build the binary (executable) for your operating system:

1. Open a terminal in the project root directory.
2. Build the project: wails build

For the Raspberry Pi (cross-compile)

TODO

Structure

/backend/acquisition

Contains the backend. (data acquisition, data transformation, etc.)

/backend/cmd ^_(TODO)

Contains the code reading arguements passed from the CLI.
^{(CLI: Command Line Interface)}

/backend/config ^_(TODO)

Contains the code reading the configuration from a file.

/frontend

Contains the frontend. (VueJS)

TODOs

• CLI ^_(/cmd): read args from command line. (see spf13/cobra)
• Config ^_(/config): read configurations from files. ( see spf13/viper)
• Backend ^{_{(/acquisition)}}
  • Data acquisition: read data received by the RF module.
  • Transform data: transform raw data into a human readable form.
  • Save data: save transformed data into a file.
  • Read data: add the possibility to read data from a file.
  • Tests: create unit tests.
    • Data acquisition: test functions of the data acquisition.
    • Transfrom data: test functions tranforming the data.
    • Save data: test functions saving data into files.
    • Read data: test functions reading data from files.
• Controller ^{_{(/controller)}}
  • Bindings: create bindings allowing the frontend to call Go functions.
  • Dispatch: create functions to send data to frontend.
  • Tests: create unit tests.
    • Bindings: test bindings functions.
    • Dispatch: test dispatch functions.
• Frontend ^{_(/dashboard)}
  • Data reception: create the functions receiving the data from the backend.
  • Tests: create unit tests.
    • Data reception: test the functions used to receive the data from the backend.
    • Other: test other functions of the frontend.