A FOSS countdown made for event tech

Go to file

Sören Oesterwind b04a376b1d Merge pull request 'Rewrite of timerpage' (#7) from better-timer-page into master Reviewed-on: #7		2022-11-15 18:48:57 +01: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	small cleanup	2022-11-13 00:46:18 +01:00
lang	- rewrote timerview	2022-11-13 21:57:01 +01:00
static	fix onresize issue	2022-11-15 18:46:06 +01:00
templates	fix onresize issue	2022-11-15 18:46:06 +01:00
.gitignore	small cleanup	2022-11-13 00:46:18 +01:00
build_win.sh	add windows build script	2022-11-15 18:26:50 +01:00
build.sh	add electron packaging	2022-11-13 00:30:42 +01:00
helpers.js	Add language settings in UI	2022-05-12 21:01:49 +02:00
index.js	- rewrote timerview	2022-11-13 21:57:01 +01: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	small cleanup	2022-11-13 00:46:18 +01:00
package-lock.json	small cleanup	2022-11-13 00:46:18 +01:00
package.json	bump version in package.json	2022-11-13 21:58:25 +01:00
README.MD	small cleanup	2022-11-13 00:46:18 +01:00
startHandler.js	some cleanup and fixes	2022-11-13 20:01:41 +01: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 dependencies
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

We've introduced a new packaging system. It is based on electron-builder. This allows for easy packaging of the application for different platforms.

chmod +x ./build.sh
./build.sh

Binary Builds may be faulty or non-working. They are not officially 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