Development Setup

Backend Development

Warning

Always be aware of piping commands to any shell - this is the recommended method for poetry but there are other options.

Windows

Note

Do not install python from the Windows Store - it will not work with these instructions.

Install python version 3.9 or above.
Install git.
Install Build Tools for Visual Studio 2022
- When asked for Workloads, select “Desktop development with C++”
- Included
  
  C++ Build Tools core features
  
  C++ 2022 Redistributable Update
  
  C++ Core desktop features
- Optional
  
  MSVC v143 - VS 2022 C++ x64/x86 build tools (vXX,XX)
  
  Windows SDK
  
  C++ CMake tools for Windows
  
  Testing tools core features - Build Tools
  
  C++ AddressSanitizer
- The default install options are appropriate.
Reboot

Install poetry using PowerShell:

$ (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Clone the main branch from the LedFx Github repository:
```
$ git clone https://github.com/LedFx/LedFx.git
```
Install LedFx and its requirements using poetry:
```
$ cd LedFx
$ poetry install
```
This will let you run LedFx directly from the cloned repository via:
```
$ ledfx --open-ui
```

Linux

Note

This assumes an apt based system such as ubuntu. If your system uses another package manager you should be able use it to get the required packages.

Install poetry:

$ curl -sSL https://install.python-poetry.org | python3 -

Clone the main branch from the LedFx Github repository:
```
$ git clone https://github.com/LedFx/LedFx.git
```

Install system dependencies via apt install:

$ sudo apt install libatlas3-base \
      libavformat58 \
      portaudio19-dev \
      pulseaudio \

Install LedFx and its requirements using poetry:
```
$ cd LedFx
$ poetry install
```
This will let you run LedFx directly from your local copy via:
```
$ ledfx --open-ui
```

macOS

Install poetry:

$ curl -sSL https://install.python-poetry.org | python3 -

Clone the main branch from the LedFx Github repository:
```
$ git clone https://github.com/LedFx/LedFx.git
```
Install LedFx and its requirements using poetry:
```
$ cd LedFx
$ poetry install
```
This will let you run LedFx directly from your local copy via:
```
$ ledfx --open-ui
```

Document Development

The documentation is written in reStructuredText. Once you are finished making changes, you must build the documentation. To build the LedFx documentation follow the steps outlined below:

Note

Alternatively, you may run make livehtml in place of make html to open a browser and view your changes in realtime.

Linux

$ cd ~/ledfx/docs
$ pip install -r requirements-docs.txt
$ make html

macOS

$ source ~/ledfx-venv/bin/activate
$ cd ~/ledfx/docs
$ pip install -r requirements-docs.txt
$ make html