Development

Fluidd is built using VueJS, and the Vuetify Framework to provide a cohesive, easily to implement UI.

Dev Container in Visual Studio Code

Fluidd includes a Dev Container configuration to easily open with Visual Studio Code (VSCode) and have every tool and dependency installed.

Install Visual Studio Code

Follow the instruction from Visual Studio Code to install.

Make sure to also install the Dev Containers extension so that VSCode knows how to use the Dev Container configuration.

Install Docker

Follow the instruction from Docker to install.

Open the Dev Container

At this point all you need to do is open Fluidd folder in VSCode and you should see a popup indicating that it found a Dev Container configuration file; click the “Reopen in Container” to have everything configured.

The configuration includes a container running docker-klipper-simulavr, a virtualized Klipper and Moonraker image that makes it easy to debug without a real printer.

Running Fluidd locally

Install Node v20

Follow the instructions from Node.js to install Node.js, v20.x.

Check that Node.js was installed properly:

$ node --version
v20.9.0
$ npm --version
10.1.0

Install dependencies

$ cd .../path/to/fluidd
$ npm install

Run a local development server

$ npm run-script serve

Browse to http://localhost:8080/ and type in the URL of your Moonraker instance, e.g. http://192.168.0.101:7125.

Run unit tests

$ npm run test:unit

Table of contents