{"id":21399664,"url":"https://github.com/natancabral/electron-updater-app","last_synced_at":"2026-05-08T11:32:50.247Z","repository":{"id":114483435,"uuid":"406030745","full_name":"natancabral/electron-updater-app","owner":"natancabral","description":"Example Auto Updating Electron App, built with electron-builder.","archived":false,"fork":false,"pushed_at":"2022-03-16T19:45:59.000Z","size":1307,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T15:52:46.655Z","etag":null,"topics":["electron","electron-app","electron-updater","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/natancabral.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}},"created_at":"2021-09-13T15:36:51.000Z","updated_at":"2021-10-20T17:35:06.000Z","dependencies_parsed_at":"2023-05-16T22:30:38.170Z","dependency_job_id":null,"html_url":"https://github.com/natancabral/electron-updater-app","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/natancabral/electron-updater-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natancabral%2Felectron-updater-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natancabral%2Felectron-updater-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natancabral%2Felectron-updater-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natancabral%2Felectron-updater-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/natancabral","download_url":"https://codeload.github.com/natancabral/electron-updater-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natancabral%2Felectron-updater-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32778510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"ssl_error","status_checked_at":"2026-05-08T08:22:45.650Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["electron","electron-app","electron-updater","nodejs"],"created_at":"2024-11-22T15:16:07.724Z","updated_at":"2026-05-08T11:32:50.240Z","avatar_url":"https://github.com/natancabral.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron Updater App\r\n\r\n\u003cp align=\"center\"\u003e\r\n\u003cstrong\u003eWindows\u003c/strong\u003e and \u003cstrong\u003eUnix\u003c/strong\u003e minimal Electron applications with auto updates implemented\u003cbr/\u003e\r\n(based on the \u003ca href=\"https://github.com/electron/electron-quick-start\"\u003eelectron-quick-start\u003c/a\u003e).\r\n\u003c/p\u003e\r\n\r\n| Linux | Windows |\r\n|-------|---------|\r\n|\u003cimg src=\"/src/assets/screen-update-avaliable.png\"/\u003e|\u003cimg src=\"/src/assets/screen-update-avaliable-win-10.png\"/\u003e|\r\n\r\n## Try it\r\nThe latest version of this example is `1.0.2`. So, you can download the [`1.0.1`](https://github.com/natancabral/electron-updater-app/releases/tag/v1.0.1) one and see how the app finds the new version and downloads it.\r\n\r\n\r\n## To begin\r\n\r\n```bash\r\n$ git clone https://github.com/natancabral/electron-updater-app.git\r\n$ cd electron-updater-app\r\n$ npm install\r\n$ npm run start\r\n$ npm run build\r\n```\r\n## Configure\r\n\r\n- [Token](#token)\r\n  - Get your token [here](https://github.com/settings/tokens/new) or [read this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\r\n- [File YML](#file-yml)\r\n  - electron-builder.yml\r\n- [Configure package.json](#configure-packagejson)\r\n  - build \u003e publish\r\n- [Release](#release):\r\n  - Create a [realease](https://github.com/natancabral/electron-updater-app/releases)\r\n  - Title: **1.0.x** and Tag: **v1.0.x** (letter v... on tag)\r\n\r\n#### Token\r\n- You need a token\r\n- https://github.com/settings/tokens/new\r\n- [More information](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\r\n\r\n#### File YML\r\n- Rename **fake_electron-builder.yml** file to **electron-builder.yml** and change data\r\n```yml\r\nappId: com.natancabral.electron-updater-app\r\npublish:\r\n  provider: github\r\n  owner: natancabral\r\n  repo: electron-updater-app\r\n  token: [YOUR GITHUB ACCESS TOKEN]\r\n  vPrefixedTagName: true\r\n```\r\n- Sample:\r\n```yml\r\nappId: com.[yourusername].[repo]\r\npublish:\r\n  provider: github\r\n  owner: [yourusername]\r\n  repo: [repo]\r\n  token: [token]\r\n  vPrefixedTagName: true\r\n```\r\n\r\n\r\n#### Configure package.json\r\n- Change appId\r\n```json\r\n\"appId\": \"com.[yourusername].[repo]\",\r\n```\r\n- Change publish\r\n```json\r\n\"build\": {\r\n  \"publish\": [{\r\n    \"provider\": \"github\",\r\n    \"owner\": \"[yourusername]\",\r\n    \"repo\": \"[repo]\"\r\n  }],\r\n},\r\n```\r\n- Release to alternative download\r\n```json\r\n\"release\": {\r\n  \"provider\": \"github\",\r\n  \"owner\": \"[yourusername]\",\r\n  \"repo\": \"[repo]\",\r\n  \"releases\": \"https://github.com/[yourusername]/[repo]/releases/\",\r\n  \"template\": **NO_CHANGE_THIS**\r\n},\r\n```\r\n\r\n#### Release\r\n\r\n- On terminal: ```npm run build:win:publish``` or to not publish```npm run build:win```\r\n- Upload all file (./dist)\r\n- https://github.com/[yourusername]/[repo]/releases\r\n- Remenber: title: **1.0.x** and tag: **v1.0.x** (letter v... on tag)\r\n- Semantic Versioning: https://semver.org/\r\n\r\n\u003cp align=\"center\"\u003e\r\n  \u003cimg src=\"/src/assets/screen-list-files.png\"/\u003e\r\n\u003c/p\u003e\r\n\r\n#### Notes\r\n- Documentation [here](https://www.electron.build/auto-update.html)\r\n- *afterPackRenameFiles.js* to rename package files.\r\n- DEV mode not work, only after ```npm run build```.\r\n- Mac sample 1: [article](https://medium.com/@johndyer24/creating-and-deploying-an-auto-updating-electron-app-for-mac-and-windows-using-electron-builder-6a3982c0cee6)\r\nMac sample 2: [article](https://medium.com/jspoint/packaging-and-distributing-electron-applications-using-electron-builder-311fc55178d9)\r\n\r\n## License\r\n\r\nThe MIT License.\r\n\r\n## Author\r\n\r\n\u003ctable\u003e\r\n  \u003ctr\u003e\r\n    \u003ctd\u003e\r\n      \u003cimg src=\"https://github.com/natancabral.png?s=100\" width=\"100\"/\u003e\r\n    \u003c/td\u003e\r\n    \u003ctd\u003e\r\n      Natan Cabral\u003cbr /\u003e\r\n      \u003ca href=\"mailto:natancabral@hotmail.com\"\u003enatancabral@hotmail.com\u003c/a\u003e\u003cbr /\u003e\r\n      \u003ca href=\"https://github.com/natancabral/\"\u003ehttps://github.com/natancabral/\u003c/a\u003e\r\n    \u003c/td\u003e\r\n  \u003c/tr\u003e\r\n\u003c/table\u003e\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatancabral%2Felectron-updater-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatancabral%2Felectron-updater-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatancabral%2Felectron-updater-app/lists"}