Skip to content

How to build from source

Woody edited this page Jan 24, 2021 · 8 revisions

How to build from source

Prerequisites:

Before proceeding with building WLED-GUI from source you need to install Node.js (version 14 or higher).
To check that Node.js was installed correctly, type the following commands in your terminal client:

node -v
npm -v

Also you need to install GIT.

Clone repository

To clone the repository, execute the following command in your terminal inside the WLED-GUI folder:

Latest version:

git clone https://github.com/WoodyLetsCode/WLED-GUI.git

This version is the latest version of WLED-GUI.

Release version:

git clone https://github.com/WoodyLetsCode/WLED-GUI.git --branch v0.6.0

This clones the repository of WLED-GUI version 0.6.0. Replace v0.6.0 with the version you want to clone.

Install dependencies

To install the dependencies, execute the following command in your terminal:

npm install

Start program

To start the program, execute the following command:

npm start

Build for Windows

To build the app, execute the following command:

npm run "build windows"

Build for Windows (one-click)

To build the app, execute the following command:

npm run "build windows oneclick"

Build for Windows (msi)

To build the app, execute the following command:

npm run "build windows msi"

Build for Windows (msi one-click)

To build the app, execute the following command:

npm run "build windows msi oneclick"

Build for Linux (AppImage)

To build the app, execute the following command:

npm run "build linux"

Build for Linux (deb)

To build the app, execute the following command:

npm run "build linux deb"

If you get errors, you may have to install binutils:

sudo apt install binutils

Build for Linux (rpm)

To build the app, execute the following command:

npm run "build linux rpm"

If you get errors, you may have to install rpm:

sudo apt install rpm

Build for Linux (snap)

To build the app, execute the following command:

npm run "build linux snap"

Build for Linux (freebsd)

To build the app, execute the following command:

npm run "build linux freebsd"

Build for MacOS

To build the app, execute the following command:

npm run "build mac"

⚠️ Info

Don’t expect that you can build app for all platforms on one platform.