1.0 release

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+# Run the automated test suite (issue #26) on every push and pull request so a
+# broken calculation can't merge unnoticed.
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+
+# Cancel an in-progress run when a newer commit is pushed to the same ref.
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Deno
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: v2.x
+
+      - name: Lint
+        run: deno lint js/ ts/
+
+      - name: Run tests
+        run: deno task test

Dockerfile

@@ -6,8 +6,7 @@ RUN apt-get update -q && \
 
 WORKDIR /local
 
-# Prefer not to be on latest commit to ensure consistency. (This may change)
-RUN git clone --depth 1 --branch v0.0.6-beta https://github.com/wittend/mag-usb
+RUN git clone https://github.com/wittend/mag-usb
 
 RUN cd mag-usb && \
     cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DENABLE_WEBSOCKET=ON && \

README.md

@@ -26,34 +26,45 @@ This repository is designed to be used alongside the HamSCI ground magnetometer.
 Instructions for setting up the magnetometer are available
 [here](https://hamsci.org/mag_install).
 
-An additional computer running Linux or macOS is required to host the
-magnetometer.
+A computer running Linux or macOS is required to host the magnetometer. The
+dashboard can be hosted on the same computer as the magnetometer or a separate
+client.
 * If using Linux, Ubuntu is recommended, but other distributions should also
   work.
 * If using macOS, Docker Desktop is required to run mag-usb.
-* Raspberry Pis and Windows are unsupported.
+* Windows is unsupported.
 
 ### Software
 
 [Mag-usb](https://github.com/wittend/mag-usb) must be installed on the host
 machine with WebSocket mode enabled.
 
+[Deno](https://deno.com) is used to serve the dashboard. Installing Deno is
+preferred for Linux clients.
+
 [Docker Desktop](https://www.docker.com/products/docker-desktop/) is preferred
-for running the project. The dashboard is served via a Deno container.
+for Windows or macOS clients. The project is run through a Deno container.
 
 ## Usage
 
-In the vendor folder, unzip the archive containing fontawesome.
+In the project's vendor folder, unzip the archive containing Font Awesome.
+
+In a CLI, navigate to the project's root directory. Start the dashboard with
+Deno:
+
+```bash
+deno task dev
+```
 
-In a CLI, navigate to the project's root directory. Use `docker compose` to
-create a container:
+Or use `docker compose` to create a container:
 
 ```bash
 docker compose up -d frontend
 ```
 
 By default, the dashboard will be available at `localhost:8000`. However, the
-hostname and port can be changed as needed.
+hostname and port can be changed as needed through a .env file. A .env.example
+file is included to demonstrate how to configure the environment.
 
 The dashboard must be given a host to connect to before any data is displayed.
 The host is the IP address of the computer running mag-usb. A simple `ifconfig`
@@ -64,9 +75,17 @@ If your dashboard does not show a "Connected" status within a few seconds or
 switches to a "Failed" status, check that you entered the host correctly, then
 check mag-usb to make sure it is configured correctly.
 
-The dashboard is currently limited to one host at a time. This can be mitigated
-by opening a duplicate dashboard in another tab.
-
 The dashboard will autoscroll with the most recently collected data. You can
 zoom in/pan on specific regions of the plots to disable the autoscroll behavior.
-The behavior can be re-enabled by double clicking on the plots.
+The behavior can be re-enabled by double clicking on the plots.
+
+## Features
+
+* Real-Time data streaming via WebSocket protocol or MQTT
+* .log file uploading for historical data viewing
+* Tabbed interface for tracking multiple sources
+* Baseline post-processing and rate of change
+* Rotation post-processing
+* Moving average to smooth noisy data
+* Export live data in JSONL or CSV format (up to 1 hour continuous)
+* Light/dark theme support

compose.yaml

@@ -12,7 +12,7 @@ services:
     restart: unless-stopped
     volumes:
       - .:/app
-    command: ["deno", "task", "dev"]
+    command: ["deno", "task", "start"]
   backend:
     container_name: mag-usb
     build: .