The boilerplate ships with a single command that swaps every reference to "Electron Starter Template" for your own app name. Run it once, then forget about it.
The one command
npm run rebrand -- \
--name "Noteworthy" \
--id com.yourcompany.noteworthy \
--owner your-github-user \
--repo noteworthy-app \
--author "Your Name <[email protected]>"That's it. The script is idempotent — run it again with different values and it patches the new values in place.
What it changes
| File | What gets updated |
|---|---|
package.json |
name, productName, description, author, repository |
electron-builder.yml |
appId, productName, publish config |
src/main/protocol/ |
Deep-link scheme (electron-starter:// → noteworthy://) |
src/renderer/i18n/locales/ |
App title in English and Spanish |
README.md |
All references to the original name |
It does not redraw your logos or app icon — those need real art from you (see below).
Replace the app icon
Drop a square PNG (≥ 1024×1024, transparent background) at resources/icon.png. electron-builder auto-derives .ico (Windows) and .icns (macOS) at build time.
# Regenerate the placeholder if you want to see the format
npm run iconsReplace the brand SVGs
Three SVGs under brand/ are visual stand-ins:
brand/logo-mark.svg— square mark (favicon, dock badge)brand/logo-wordmark.svg— horizontal logo with the app namebrand/README-hero.svg— the big banner in README
Replace them with your own art. Same dimensions, any colors.
Regenerate screenshots after a brand change
The 10 PNGs under brand/screenshots/ are captures of the running app. After rebranding, regenerate them so the title bar shows your name:
bash
npm run screenshots
Ask your AI assistant
"I'm rebranding this Electron boilerplate to a notes app called 'Quill'. Suggest a color palette and a 1-sentence value prop, then tell me which files I should edit beyond what
npm run rebrandcovers."
What's next
- Learn the layout → Project structure
- Skip to shipping → Auto-update shows how to push releases to your users.