Windows

Welcome to the YourFamilyHub Installation Guide! Here you will find all commands nessary for starting front & backend.

Install

Requirements: Node.js 18+, npm, git

Manual

1. Download latest build from GitHub

2. Install dependencies: npm install

3. Start development server (frontend): npm run dev

4. Start backend server (in another terminal): node server/server.js

5. Access via http://127.0.0.1:3000/ or http://localhost:3000/ (or your pc IP/v4)

Automatic

1. Download latest build from GitHub

2. Run start.sh with GIT Bash: bash start.sh

Server Error on Startup: you may check this guide to fix a broken node_module and continue after npm install.