Developer's Guide

Getting Propeller

Propeller source can be found in the official Propeller GitHub repository. You should fork this repository in order to make changes to the project. The forked version of the repository should be cloned using the following:

git clone https://github.com/your-github-username/propeller.git $SOMEPATH/propeller
cd $SOMEPATH/propeller

Building Propeller

Prerequisites

To build Propeller, you will need the following:

• A Go compiler (Go 1.23 or later)
• Make
• Docker
• Wasmtime
• TinyGo

Building

Use the GNU Make tool to build all Propeller services:

make all

This will build Propeller for your platforms.

To build Propeller for other platforms, use the following:

Building an individual service

You can build individual services using the following:

make <service>

For example, to build the manager service, use the following:

make manager

The built binaries will be located in the build directory.

Building examples

You can build examples using the following:

make <example>

For example, to build the addition example, use the following:

make addition

This compiles the addition example to wasm and can be located in the build directory.

To test the addition example, use the following:

wasmtime --invoke add ./build/addition.wasm 1 2

This will output something like:

warning: using `--invoke` with a function that takes arguments is experimental and may break in the future
warning: using `--invoke` with a function that returns values is experimental and may break in the future
3

Installing

Once you have built Propeller, you can install it using the following:

make install

This will install Propeller to the GOBIN directory.

Linter

Propeller uses golangci-lint to lint the code. You can run the linter using the following:

make lint

SuperMQ

Starting SuperMQ

To start SuperMQ, use the following:

make start-supermq

This will in the background run docker compose -f docker/compose.yaml up -d which will start the SuperMQ services.

You can override the configuration or add some extra parameters to the docker compose configuration.

Stopping SuperMQ

SuperMQ can be stopped using the following:

make stop-supermq