BuildBook

BuildBook is a Windows desktop app for tracking electronics builds, parts, project files, photos, and step-by-step instructions.

Features

• Project tracking with notes, checklists, tags, photos, and instructions
• Parts library with categories, documents, storage locations, and project quantities
• Tracked project files with previews, linked-file monitoring, and revision history
• Import/export for projects and full workspace backups
• Optional local network access for viewing BuildBook from other devices

For the Docker version, see BuildBook_Web.

Screenshots

Install the Windows app

1. Open the Releases page.
2. Download the latest BuildBook_x64-setup.exe installer from the newest release.
3. Run the installer.
4. Launch BuildBook from Start Menu or Desktop.

Update the installed app

1. Open BuildBook.
2. Go to Settings.
3. Under Software Updates, click Check for Updates.
4. If an update is available, click Install Update.
5. The app will download the update and restart.

The updater checks GitHub Releases and installs the published Windows build.

Build from source

Requirements

• Windows
• Node.js with npm
• Rust stable toolchain
• Visual Studio C++ build tools for Windows desktop development

Run in development

npm install
npm run tauri dev

Build an installer

npm install
npm run tauri build

Build output is written under src-tauri/target/release/bundle/. The Windows installer is generated in src-tauri/target/release/bundle/nsis/.

Publish a release

1. Commit and push the completed changes to the main branch.
2. Confirm the version has been advanced for the release.
3. Double-click Publish Release.bat.
4. Type RELEASE when prompted.

The launcher reads the current app version, verifies the repo is clean and pushed, then sends the version tag to GitHub. GitHub Actions builds and publishes the Windows installer.

Update a source build

If you are running BuildBook from source and want the latest code:

git pull
npm install
npm run tauri build

If you are using npm run tauri dev, stop the running app and start it again after pulling changes:

npm run tauri dev

Notes

• This repo builds the Windows desktop app.
• Release packaging is handled by Tauri and GitHub Actions.
• Published releases are version-matched to package.json and src-tauri/tauri.conf.json.