whealthy ▸ QUICKSTART.md
updated 2026-02-28
Quick Start Guide
Run the App (Simplest Method - Recommended)
Prerequisites: Node.js ≥20.9.0 (check with node -v)
-
Install dependencies:
bash npm install -
Start the development server:
bash npm run dev -
Open your browser: - Go to: http://localhost:3000 - The app should load and be fully interactive
Note: If your Node.js version is too old, upgrade it or use Docker (see below).
What You Should See
- Inputs tab: Configure wealth, spending, taxes, allocations
- Inflows & One-offs tab: Add/remove cash flow events
- Results tab: View charts and key statistics
- Notes tab: Model documentation
Test Interactivity
- Tabs: Click between “Inputs”, “Inflows & One-offs”, “Results”, “Notes” - they should switch
- Toggles: - “Real mode” switch should toggle - “Enable commitments engine” should toggle - “Enable Monte Carlo” should toggle
- Preset buttons: Click “$10m / $300k / 1% philanthropy”, “High inflation”, etc. - values should update
- Input fields: Change any number - charts should update after a brief delay
- Results tab: Should show wealth projection chart and key stats
If Something Doesn’t Work
- Check browser console (F12) for errors
- Clear localStorage: Open browser DevTools → Application → Local Storage → Clear “whealthy-params”
- Restart the dev server: Stop (Ctrl+C) and run
npm run devagain
Alternative: Use Docker (No Node Version Issues)
Note: Docker requires Docker Hub authentication. If you get an “email must be verified” error, see DOCKER_FIX.md.
If you have Docker installed and authenticated:
docker compose up --build
Then open http://localhost:3000
Troubleshooting
- “Node version too old”: Upgrade Node.js to ≥20.9.0 or use Docker
- Tabs don’t switch: Check browser console for JavaScript errors
- Toggles don’t work: Ensure JavaScript is enabled in your browser
- Charts don’t show: Wait a moment for simulation to complete (check “Loading simulation…” message)