A FOSS countdown made for event tech

Go to file

Sören Oesterwind 4e28df6eea „README.MD“ ändern		2022-10-28 18:43:08 +02:00
.vscode	Add vscode debug config.	2022-03-27 13:52:24 +02:00
docs	- add a build command	2022-07-13 18:26:50 +02:00
electronAssets	- add gui electron application	2022-08-18 22:00:24 +02:00
lang	Add language settings in UI	2022-05-12 21:01:49 +02:00
static	- add gui electron application	2022-08-18 22:00:24 +02:00
templates	- removed symblic links	2022-08-18 18:15:36 +02:00
.gitignore	fix progressbar not disappearing	2022-07-12 22:15:27 +02:00
build.ssh	- add a build command	2022-07-13 18:26:50 +02:00
helpers.js	Add language settings in UI	2022-05-12 21:01:49 +02:00
index.js	- add gui electron application	2022-08-18 22:00:24 +02:00
LICENSE.txt	added license; color picker update	2022-03-06 18:07:51 +01:00
log-journal.json	- add gui electron application	2022-08-18 22:00:24 +02:00
logging.js	add logging system	2022-03-30 16:16:59 +02:00
newStartHandler.js	- add gui electron application	2022-08-18 22:00:24 +02:00
package-lock.json	- add gui electron application	2022-08-18 22:00:24 +02:00
package.json	- add gui electron application	2022-08-18 22:00:24 +02:00
README.MD	„README.MD“ ändern	2022-10-28 18:43:08 +02:00

README.MD

openCountdown

openCountdown is a professional software for event countdowns. It can be used in a live settings such as a music event. Support for companion is currently being worked on here.

Installation

You can download complete binaries from the release tab.

Development build

Download the repository
npm install to install dependecies
npm start to launch

Startup Arguments

One can pass a --headless argument to start the server in headless mode. This will disable the GUI.

Packaging

This is more a comment for the future version of me. There is one command for packaging using nexe.

npx nexe index.js --build --python python3 --resource "./{lang,templates,static}/**/*" --ouput "openCountdown.exe”

Where --python is only needed in some envoirments for some reason. Also adjust --output for your target OS.

Binary Builds may be faulty or non-working. They are not offically supported. Small disclaimer: Please do not use openCountdown for military or life-depending applications. Please also refrain from using openCountdown for launching rockets.

ToDo

Endpoint documentation is currently pretty thin. This will be changed in the future.

Endpoint docs (in Progress)
Better WS frames