# Windows Deployment Instructions ## Quick Deployment to D:\hosted\familyhub (or any location) ### Step 1: Download and Extract 1. Download `familyhub-windows.zip` 2. Extract to your desired location (e.g., `D:\hosted\familyhub`) 3. Open Command Prompt in that folder ### Step 2: Check Prerequisites (Optional but Recommended) ```cmd check-requirements.bat ``` This verifies that Python and Node.js are installed. ### Step 3: Download Source Code (REQUIRED!) ```cmd download-source.bat ``` **IMPORTANT:** You MUST run this before setup.bat! This script will: - Download complete source code from Gitea - Copy backend/ and frontend/ folders with all files - Works with or without Git installed ### Step 4: Run Setup (One-Time) ```cmd setup.bat ``` This will: - Create Python virtual environment - Install all dependencies - Initialize database with demo data ### Step 5: Start the Application Choose one option: **Option A - Two Separate Terminals:** ```cmd start-backend.bat (Terminal 1) start-frontend.bat (Terminal 2) ``` **Option B - Single Command:** ```cmd start-all.bat ``` ### Step 6: Access the Application - Frontend: http://localhost:5173 - Backend API: http://localhost:8001/docs - Login: `jess` / `password123` ## Files Overview ### Included Scripts - `check-requirements.bat` - Verify Python and Node.js are installed - `download-source.bat` - Download source code from Gitea (RUN FIRST!) - `setup.bat` - One-time setup (creates venv, installs dependencies, initializes database) - `start-backend.bat` - Starts FastAPI backend server - `start-frontend.bat` - Starts Vite development server - `start-all.bat` - Starts both backend and frontend in separate windows - `stop-all.bat` - Stops all running services ### Included Configuration - `backend/.env` - Backend configuration (database path, CORS settings) - `frontend/.env` - Frontend configuration (API URL points to localhost) - `backend/init_db.py` - Database initialization with 12 demo chores ### Documentation - `QUICK_START.txt` - Quick reference guide - `DEPLOYMENT.md` - This file - `README.md` - Complete setup and usage guide ## Important Notes 1. **Source Code Download**: The `download-source.bat` script automatically downloads the complete Family Hub source code from Gitea. It works with or without Git installed. 2. **Database Location**: The SQLite database will be created at `backend\data\family_hub.db` when you run setup. 3. **Port Configuration**: The setup uses: - Backend: `localhost:8001` - Frontend: `localhost:5173` 4. **Prerequisites**: Python 3.9+ and Node.js 16+ must be installed and added to PATH. Use `check-requirements.bat` to verify. ## Next Steps After Setup 1. Test login with admin account (`jess` / `password123`) 2. Explore the 12 pre-loaded demo chores 3. Try creating new chores and marking them complete 4. Review the Settings page (admin access only) 5. Check API documentation at http://localhost:8001/docs ## Troubleshooting If download-source.bat fails: - Check internet connection to Gitea server (10.0.0.127) - Try accessing https://gitea.hideawaygaming.com.au/jessikitty/family-hub in a browser - If using PowerShell method, ensure TLS 1.2 is enabled If setup fails with "No such file or directory": - **YOU FORGOT TO RUN download-source.bat FIRST!** - The source code files must be downloaded before setup can run If setup fails, check: - Python is in PATH: `python --version` - Node.js is in PATH: `node --version` - npm is in PATH: `npm --version` - Use `check-requirements.bat` to verify all prerequisites For port conflicts: - Run `stop-all.bat` to kill all services - Or manually: `netstat -ano | findstr :8001` then `taskkill /PID /F` For detailed troubleshooting, see the main README.md file.