anyerqi/Website to Electron
Package a built static website into an Electron desktop app via Electron Forge.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| site-path | Path to the built static site directory to embed. | yes | dist |
| app-name | Package name (kebab-case) used by Electron Forge. | no | website-app |
| product-name | Display/product name shown in installers. | no | Website App |
| app-version | Version to embed in the packaged app. | no | — |
| app-description | Description shown in installers. | no | — |
| author | Author name to set in package.json. | no | — |
| icon-icns-path | Path to a .icns icon for macOS builds. | no | — |
| icon-ico-path | Path to a .ico icon for Windows builds. | no | — |
| icon-png-path | Path to a .png icon used by DMG/background assets. | no | — |
| auto-update | Enable auto-update via GitHub Releases (uses current repository). Will publish artifacts to GitHub Releases. | no | false |
| github-token | GitHub token for publishing releases (required if auto-update is true). Use secrets.GITHUB_TOKEN. | no | — |
Outputs
| name | description |
|---|---|
| artifact-path | Location of the generated Electron Forge artifacts. |