Skip to content

electron-delta/electron-sample-app

Repository files navigation

Electron sample app

A complete example of an auto-updating app demonstrating the delta updates. The app is built using electron-builder and @electron-delta/builder

Delta auto updates are handled by @electron-delta/updater

Delta updates

Installation

git clone [email protected]:electron-delta/electron-sample-app.git
cd electron-sample-app
npm install

Testing delta releases

Let's create the first version of the app.

  1. Open the src/main.js and set the hostURL to http://localhost:5000/
  2. Open .electron-delta.js and use the following getPreviousReleases method
const getPreviousReleases = async () => {
  return [];
};
  1. Change the version to 1.0.0 and create the distribution files.
npm version 1.0.0
npm run dist
  1. Now serve the dist files over port 5000.
npx serve -s dist -p 5000
  1. Open .electron-delta.js and use the following getPreviousReleases method
const getPreviousReleases = async () => {
  return [
    {
      version: '1.0.0',
      url: 'http://localhost:5000/electron-sample-app-1.0.0.exe',
    }
  ];
};
  1. Change the version to 1.0.1 and create the distribution files.
npm version 1.0.1
npm run dist
  1. Notice that a new folder is created under /dist/1.0.1-delta-installers. Move all those files to /dist/. Make this url http://localhost:5000/delta.json is working.

  2. Now install the electron-sample-app-1.0.0.exe app. Your app should be auto updated to 1.0.1 using delta updates.