Skip to content

Quick Start

Fins1600 edited this page May 11, 2026 · 1 revision

Quick Start

Install and run

git clone https://github.com/Fins1600/weekaroo.git
cd weekaroo
chmod +x install.sh run-dashboard.sh run-demo.sh
./install.sh
./run-dashboard.sh

Then open:

http://127.0.0.1:4020

Headless or kiosk install

If you do not want a desktop shortcut, run:

INSTALL_DESKTOP_SHORTCUT=0 ./install.sh

If you do not want the launcher to open a browser automatically, run:

OPEN_BROWSER=0 ./run-dashboard.sh

Run on a different port

The default port is 4020. If another dashboard is already using that port, choose another one:

PORT=4021 OPEN_BROWSER=0 ./run-dashboard.sh

Then open:

http://127.0.0.1:4021

Demo mode

To evaluate Weekaroo without personal data:

OPEN_BROWSER=0 ./run-demo.sh

Demo mode copies synthetic demo files into the local ignored config names, then starts the dashboard.

Clone this wiki locally