Getting Started

Basics

MUSCLE is built up with the following parts:

  • The backend REST API implemented with Flask

  • The web interface implemented with Vue.js

  • Multiple device nodes to be implemented by you based on a skeleton also implemented with Flask

The Path to a Working Setup

To get MUSCLE up and running end-to-end, follow these steps:

  1. Install the application (Docker is the easiest way, see this section for both options).

  2. Log in with the default administrator, see Testing, and consider setting up your own admin user, see Users & Roles.

  3. Implement and start a device, see Implementing Devices.

  4. Register the device in the webapp, see Registering a Device.

  5. Open the device’s send page in the webapp to test it.

The sections below go into more detail for steps 1 and 3.

Installing the Application

We recommend to setup the backend and web application in a first step, so you can test the devices while implementing them.

Start with this section to install and setup the web application.

Implementing the Devices

In a second step the devices can be implemented. Read the devices getting started guide for a detailed description.