Keygen + Electron Example

Clone and run for a quick way to see Electron in action.

This is a minimal Electron application integrated with Keygen to handle licensing certain app features individually via user-accounts, as well as providing auto-updates using Keygen Dist. It is based on the Quick Start Guide within the Electron documentation.

⚠️ For a much simpler Electron app example (only license key validation—no user login, no auto-updates, etc.), check out our basic Electron app example.

Use this app along with the Electron API Demos app for API code examples to help you get started.

A basic Electron application needs just these files:

package.json - Points to the app's main file and lists its details and dependencies.
main.js - Starts the app and creates a browser window to render HTML. This is the app's main process.
index.html - A web page to render. This is the app's renderer process.

You can learn more about each of these components within the Quick Start Guide.

To Use

To download the macOS version of this app and take it for a spin without having to build it locally, use this download link (auto-updates are disabled in the pre-built version). To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/keygen-sh/example-electron-app
# Go into the repository
cd example-electron-app

Next, install dependencies with yarn:

yarn

Then start the app:

yarn start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

To Build

To test auto-update functionality and build the application (currently macOS only), run the following:

CSC_LINK=/path/to/your/cert.p12 yarn dist

Note: You'll need to have a trusted developer certificate set up so that you can sign the app. A self-signed certificate will work for non-production use as long as it is set to "always be trusted". Auto-updates will not work unless the app is signed.

To Login

Use the email demo@example.com and the password demo.

Resources for Learning Electron

electron.atom.io/docs - all of Electron's documentation
electron.atom.io/community/#boilerplates - sample starter apps created by the community
electron/electron-quick-start - a very basic starter Electron app
electron/simple-samples - small applications with ideas for taking them further
electron/electron-api-demos - an Electron app that teaches you how to use Electron
hokein/electron-sample-apps - small demo apps for the various Electron APIs

License

CC0 1.0 (Public Domain)

javaxiaomangren / example-electron-app