Developer Installation

Owned by Sören Oesterwind
Nov 23, 2022
1 min read

If you want to get started with developing you should first get a developer instance up and running. This guide will show you through the setup.

Prerequisites

In order to use openCountdown in a developer environment there are a few prerequisites:

  • NodeJS

  • Your favourite IDE (I use vscode)

  • git

  • (Additionally, Companion if you want to develop the module)

Initial setup

After making sure you have all requisites installed you are ready to go. A few more steps are necessary when setting up initially.

  1. Run git clone https://git.project-name-here.de/Project-Name-Here/openCountdown.git to download the codebase

  2. Run npm install to download all dependencies

Running the server

In a developer environment, you most likely want to use the --headless in order to skip the Electron launcher. Providing --headless will just run the server. This is also useful when running on a system without an X-Server.

To start the server use node startHandler.js --headless

The server will now run and you a ready to start developing.

To stop the server simply hit Ctrl + C in the console or use a taskmanager to quit the app.