3_softeng_zh_2023

This software project was implemented for the MSE TSM_SoftwEng lecture 2023. It consists of a microcontroller recording temperature data, which gets sent to a web service. The data can be viewed with a web-based GUI.

The architecture documentation is deployed on GitLab Pages.

Contributing

Getting setup for development should be as easy as running ./dev/setup.sh. If the script doesn't work, read it to figure out what it was supposed to do. If mostly installs a bunch of system dependencies and development tools.

Although the release build is a single static executable, there are several processes running for development. This provides auto reloading of backend, frontend, documentation and diagrams whenever something changes. Run just zellij to start everything. It's recommended to run zellij in a standalone terminal emulator to avoid keyboard shortcut conflicts. You can also figure out how to run everything manually by reading ./dev/zellij.kdl and the justfile.

You might want to quickly familiarize yourself with the following dev tools:

just, a simple command runner
zellij, a terminal workspace / multiplexer

Installation

The straightforward way to install a release build of the application is to download the prebuilt binaries for x86_64 and aarch64 (Linux) on the Releases page.

Alternatively, you can build a container image using the provided Containerfile. Example:

podman build -t softw-eng .
podman run -it --rm -p 4000:4000 softw-eng

Usage

Run the executable to start the server (--help works as expected). Navigate to localhost:4000 (or the port you configured) to use the GUI. You can add and delete temperature measurements for demonstration, as well as navigate to the embedded documentation. The REST API is not documented, you have to check the source if you want to make API requests without the GUI.

Testing

There are examples of several different testing approaches:

approach	location
unit	`server/src/state.rs`
integration	`server/tests/integration.rs`
end-to-end	`e2e/*`

Note that the end-to-end tests are not polished to the point of being easily automatable. The serve as a proof of concept. The app must be run in development mode locally (localhost:3000) before the tests work.

License