{"id":29135722,"url":"https://github.com/ColdByDefault/electron-auto-updater","last_synced_at":"2025-06-30T10:07:49.728Z","repository":{"id":289446810,"uuid":"969508174","full_name":"ColdByDefault/electron-auto-updater","owner":"ColdByDefault","description":"Simple Windows Desktop App Template","archived":false,"fork":false,"pushed_at":"2025-04-23T09:47:56.000Z","size":153,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T23:47:06.317Z","etag":null,"topics":["css","electron","electron-builder","electron-updater","html","nodejs"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ColdByDefault.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-20T10:04:54.000Z","updated_at":"2025-04-23T09:49:09.000Z","dependencies_parsed_at":"2025-04-23T10:47:20.967Z","dependency_job_id":null,"html_url":"https://github.com/ColdByDefault/electron-auto-updater","commit_stats":null,"previous_names":["coldbydefault/electron-auto-updater"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ColdByDefault/electron-auto-updater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColdByDefault%2Felectron-auto-updater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColdByDefault%2Felectron-auto-updater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColdByDefault%2Felectron-auto-updater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColdByDefault%2Felectron-auto-updater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ColdByDefault","download_url":"https://codeload.github.com/ColdByDefault/electron-auto-updater/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ColdByDefault%2Felectron-auto-updater/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262753173,"owners_count":23358884,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css","electron","electron-builder","electron-updater","html","nodejs"],"created_at":"2025-06-30T10:07:47.936Z","updated_at":"2025-06-30T10:07:49.667Z","avatar_url":"https://github.com/ColdByDefault.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron App with Auto-Updater for Windows\n\n**A simple Windows desktop application built with Electron, Node.js, HTML, and CSS. It checks for updates from a GitHub repository and auto-updates itself using GitHub Releases.**\n\n## Features\n\n- 🧭 Auto-check for updates on launch\n- 🚀 Auto-download and install updates from GitHub Releases\n- 🔁 Silent update \u0026 restart\n- 💻 Built for Windows (32/64-bit)\n\n## Tech Stack\n\n- [Electron](https://www.electronjs.org/)\n- [Node.js](https://nodejs.org/)\n- HTML \u0026 CSS\n- [electron-updater](https://www.electron.build/auto-update) via [electron-builder](https://www.electron.build/)\n- GitHub Releases for deployment\n\n## Prerequisites\n\n- Node.js (v18 or later)\n- Git\n- Windows OS (Tested on Windows 10/11)\n- A GitHub repository with signed releases (for updates)\n\n## Getting Started\n\n1. **Clone the repo**\n   ```bash\n   git clone https://github.com/ColdByDefault/electron-auto-updater.git\n   cd electron-auto-updater\n   ```\n\n2. **Install dependencies**\n   ```bash\n   npm install\n   ```\n\n3. **Run the app in development**\n   ```bash\n   npm start\n   ```\n\n4. **Build the app for production**\n   ```bash\n   npm run dist\n   ```\n\n## Reusable Auto-Update Setup\n\nEnsure you configure the `build` section in your `package.json`:\n\n```json\n\"build\": {\n  \"appId\": \"com.yourdomain.yourapp\",\n  \"productName\": \"YourAppName\",\n  \"publish\": [\n    {\n      \"provider\": \"github\",\n      \"owner\": \"your-username\",\n      \"repo\": \"your-repo\"\n    }\n  ],\n  \"win\": {\n    \"target\": \"nsis\"\n  },\n  \"nsis\": {\n    \"oneClick\": false,\n    \"perMachine\": true,\n    \"allowToChangeInstallationDirectory\": true\n  }\n}\n```\n\n\u003e 🔐 Make sure your GitHub repo has signed releases and you generate `.yml` and `.exe` assets during packaging.\n\n## How Updates Work\n\n1. On launch, the app checks the GitHub Releases API for a new version.\n2. If a new version is found, it's downloaded automatically.\n3. When the download is complete, the app prompts or automatically installs the update and restarts.\n\n## Publishing Updates\n\n1. Update your app version in `package.json`.\n2. Build the release:\n   ```bash\n   npm run dist\n   ```\n3. Create a new GitHub Release and upload the generated `.exe` and `.yml` files from the `dist` folder.\n\n## Security Tips\n\n- Always sign your releases\n- Never expose sensitive keys in your codebase\n- Use `.env` files or GitHub Secrets for CI/CD\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FColdByDefault%2Felectron-auto-updater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FColdByDefault%2Felectron-auto-updater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FColdByDefault%2Felectron-auto-updater/lists"}