The easiest way to get started is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need including realtime development.
- git
- Docker
- For Linux, macOS, or Windows 10 Pro/Enterprise/Education use the current release version of Docker
- Windows 10 Home requires WSL 2 and the current Edge version of Docker Desktop (see instructions here). This can also be used for Windows Pro/Enterprise/Education.
- Visual Studio code
- Remote - Containers (VSC Extension)
More info about requirements and devcontainer in general
- (Fork&) Clone the repository to your computer.
- Open the repository using Visual Studio code.
- Run Tasks
When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container.
- If you don't see this notification, open the command palette and select
Remote-Containers: Reopen Folder in Container. - First start will take some time. From the 2nd start on its gonna be fast
The devcontainer comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select Tasks: Run Task then select the task you want to run.
When a task is currently running, it can be restarted by opening the command palette and selecting Tasks: Restart Running Task, then select the task you want to restart.
The available tasks are:
| Task | Description |
|---|---|
| Run LedFx in devmode on port 8888 | Backend |
| Run Ledfx Frontend in devmode on port 3000 | Frontend |