christianandClaude Opus 5
0db5e9b07d
First commit on the local Gitea server, made after moving the tree off the Windows machine. Build outputs, node_modules and the AI models stay out (see .gitignore); everything the installer build needs is tracked. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
107 lines
3.6 KiB
Markdown
107 lines
3.6 KiB
Markdown
# Bible App Installer Guide
|
|
|
|
## Building the Installer
|
|
|
|
### Option 1: Automatic Build (Recommended)
|
|
|
|
**Watch for changes and auto-build:**
|
|
```batch
|
|
watch-and-build.bat
|
|
```
|
|
or
|
|
```bash
|
|
npm run watch
|
|
```
|
|
|
|
This will:
|
|
- Watch your files for changes
|
|
- Automatically run `build-installer.bat` when you save changes
|
|
- Increment the version and build the installer automatically
|
|
- Wait 3 seconds after your last change before building (debounced)
|
|
|
|
**Perfect for development** - just save your files and the installer builds automatically!
|
|
|
|
### Option 2: Manual Build
|
|
|
|
**Build once:**
|
|
```batch
|
|
build-installer.bat
|
|
```
|
|
or
|
|
```bash
|
|
npm run build:installer
|
|
```
|
|
|
|
**The script will automatically**:
|
|
- Increment the version number in `package.json` (e.g., 1.0.6 → 1.0.7)
|
|
- Build the installer with the new version
|
|
- Create the installer file in `dist-installer` folder
|
|
|
|
### Finding Your Installer
|
|
|
|
**Find your installer** in the `dist-installer` folder:
|
|
- File name: `Bible App Setup X.X.X.exe` (where X.X.X is the automatically incremented version number)
|
|
|
|
**Note**: The version number is automatically incremented each time you build. You don't need to manually update it!
|
|
|
|
## Installing the App
|
|
|
|
1. Double-click `Bible App Setup X.X.X.exe`
|
|
2. Follow the installation wizard
|
|
3. Choose installation directory (default: `C:\Program Files\Bible App`)
|
|
4. The installer will automatically uninstall any previous versions before installing the new one
|
|
|
|
## Uninstalling the App
|
|
|
|
1. Go to Windows Settings → Apps → Installed apps
|
|
2. Find "Bible App" in the list
|
|
3. Click the three dots (⋮) and select "Uninstall"
|
|
4. Follow the uninstall wizard
|
|
|
|
Alternatively:
|
|
- Go to Control Panel → Programs and Features
|
|
- Find "Bible App" and click "Uninstall"
|
|
|
|
## Version Management
|
|
|
|
- **Upgrading**: Simply run the new installer. It will automatically uninstall the old version first.
|
|
- **Downgrading**: Run an older installer. It will replace the newer version.
|
|
- **Version Number**: The version is automatically incremented each time you run `build-installer.bat`. The patch version (third number) increases by 1 each build (e.g., 1.0.6 → 1.0.7 → 1.0.8).
|
|
|
|
## Important Notes
|
|
|
|
- The installer creates a proper Windows application entry
|
|
- User data (Notes, Graphics, Announcements) is stored in the installation directory
|
|
- The app can be installed on any Windows machine without requiring Node.js or other dependencies
|
|
- Each version is tracked by Windows, allowing easy upgrades and downgrades
|
|
|
|
## Troubleshooting
|
|
|
|
**Build fails with "electron-builder not found"**:
|
|
- Run `npm install` to install dependencies
|
|
|
|
**Build fails with "Cannot create symbolic link" errors**:
|
|
This is a Windows permission issue. You have two options:
|
|
|
|
**Option 1: Enable Developer Mode (Recommended)**
|
|
1. Open Windows Settings (Win + I)
|
|
2. Go to **Privacy & Security** → **For developers**
|
|
3. Enable **Developer Mode**
|
|
4. Restart the build script
|
|
|
|
**Option 2: Run as Administrator**
|
|
1. Right-click `build-installer.bat`
|
|
2. Select **Run as administrator**
|
|
3. Click **Yes** when prompted
|
|
|
|
The symlink errors are related to macOS files in the code signing tools, which aren't needed for Windows builds. Enabling Developer Mode or running as admin will allow Windows to create these symlinks.
|
|
|
|
**Installer doesn't uninstall old version**:
|
|
- Make sure you're using the same `appId` in package.json (should be `com.bibleapp.desktop`)
|
|
- Manually uninstall the old version from Windows Settings first
|
|
|
|
**App doesn't start after installation**:
|
|
- Check Windows Defender or antivirus isn't blocking it
|
|
- Try running as administrator
|
|
|