UI base

.github/workflows/app-build.yml

@@ -0,0 +1,77 @@
+name: 'App Build'
+
+# trigger on app-v* created tags.
+on:
+  push:
+    tags:
+      - 'app-v*'
+  workflow_dispatch:
+
+jobs:
+  publish-tauri:
+    permissions:
+      contents: write
+    defaults:
+      run:
+        working-directory: ./gs
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - platform: 'macos-latest' # for Arm based macs (M1 and above).
+            args: '--target aarch64-apple-darwin'
+          - platform: 'macos-latest' # for Intel based macs.
+            args: '--target x86_64-apple-darwin'
+          - platform: 'ubuntu-22.04' # for Tauri v1 you could replace this with ubuntu-20.04.
+            args: ''
+          - platform: 'windows-latest'
+            args: ''
+
+    runs-on: ${{ matrix.settings.platform }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: install dependencies (ubuntu only)
+        if: matrix.settings.platform == 'ubuntu-22.04' # This must match the platform value defined above.
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libwebkit2gtk-4.0-dev libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf
+        # webkitgtk 4.0 is for Tauri v1 - webkitgtk 4.1 is for Tauri v2.
+        # You can remove the one that doesn't apply to your app to speed up the workflow a bit.
+
+      - name: setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache-dependency-path: ./gs/
+          cache: 'npm'
+
+      - name: install Rust stable
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          # Those targets are only used on macos runners so it's in an `if` to slightly speed up windows and linux builds.
+          targets: ${{ matrix.settings.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
+
+      - name: Rust cache
+        uses: swatinem/rust-cache@v2
+        with:
+          workspaces: './station -> target'
+
+      - name: install frontend dependencies
+        # If you don't have `beforeBuildCommand` configured you may want to build your frontend here too.
+        run: npm install 
+
+      - name: Build Tauri App
+        id: build_tauri
+        uses: tauri-apps/tauri-action@v0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tagName: app-v__VERSION__ # the action automatically replaces \_\_VERSION\_\_ with the app version.
+          projectPath: 'gs/station/'
+          releaseName: 'App v__VERSION__'
+          releaseBody: 'See the assets to download this version and install.'
+          releaseDraft: true
+          prerelease: false
+          args: ${{ matrix.settings.args }}

gs/README.md

@@ -1,38 +1,35 @@
-# create-svelte
+# Ground station
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+This folder includes the codebase for the front-end GUI and the ground station backend.
+The GUI uses [Tauri](https://tauri.app/): a Rust framework for creating native applications.
+Tauri is coupled with [SvelteKit](https://kit.svelte.dev/) here: a JavaScript framework for web applications.
+Tauri builds its application using the front-end from SvelteKit and creates a native executable.
 
-## Creating a project
+## Sub-folder structure:
 
-If you're seeing this, you've probably already done this step. Congrats!
+- `station/` - contains Tauri backend and ground station backend
+- `src/` - contains the SvelteKit front-end of the GUI. Check out its readme for more documentation.
+- `tests/` - contains software tests for the front-end/back-end
+- `static/` - contains static files like images, icons, fonts.
 
-```bash
-# create a new project in the current directory
-npm create svelte@latest
-
-# create a new project in my-app
-npm create svelte@latest my-app
-```
+## How to run the ground station GUI:
 
-## Developing
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Ensure you have Rust, Tauri and Node.js installed. 
+If not, follow the instructions [here](https://tauri.studio/en/docs/getting-started/installation).
 
+1. Clone the repository
 ```bash
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+git clone [email protected]:delft-hyperloop/Helios_III.git
 ```
 
-## Building
-
-To create a production version of your app:
-
+2. Install dependencies
 ```bash
-npm run build
+cd Helios_III/gs
+npm install
 ```
 
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+3. Run the GUI
+```bash
+npm run tauri dev
+```