Skip to content

Electron:QuickStart

This is a minimal Electron application based on the Quick Start Guide within the Electron documentation.

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.

Example

Spin up the Quick Start app to see Electron in action:

A minimal Electron app with helpful notations.

# Clone the Quick Start repository
$ git clone https://github.com/electron/electron-quick-start

# Go into the repository
$ cd electron-quick-start

# Install the dependencies and run
$ npm install && npm start

List of npm packages

$ npm install

> [email protected] postinstall /Users/your/Project/electron-quick-start/node_modules/electron
> node install.js

[email protected] /Users/your/Project/electron-quick-start
└─┬ [email protected]
  ├─┬ [email protected]
   ├─┬ [email protected]
    └── [email protected]
   ├─┬ [email protected]
    ├── [email protected]
    ├── [email protected]
    ├── [email protected]
    ├── [email protected]
    └─┬ [email protected]
      └─┬ [email protected]
        ├── [email protected]
        ├─┬ [email protected]
         └── [email protected]
        ├─┬ [email protected]
         └─┬ [email protected]
           ├── [email protected]
           └── [email protected]
        └── [email protected]
   ├── [email protected]
   ├── [email protected]
   ├─┬ [email protected]
    ├─┬ [email protected]
     ├── [email protected]
     └─┬ [email protected]
       ├─┬ [email protected]
        └── [email protected]
       ├── [email protected]
       ├─┬ [email protected]
        ├─┬ [email protected]
         └── [email protected]
        └── [email protected]
       ├── [email protected]
       ├─┬ [email protected]
        ├── [email protected]
        ├─┬ [email protected]
         └── [email protected]
        └─┬ [email protected]
          ├─┬ [email protected]
           └── [email protected]
          └── [email protected]
       ├── [email protected]
       ├─┬ [email protected]
        ├── [email protected]
        └─┬ [email protected]
          ├─┬ [email protected]
           ├─┬ [email protected]
            └─┬ [email protected]
              └── [email protected]
           ├── [email protected]
           └─┬ [email protected]
             └── [email protected]
          └── [email protected]
       ├─┬ [email protected]
        ├─┬ [email protected]
         └─┬ [email protected]
           └── [email protected]
        └── [email protected]
       └── [email protected]
    ├─┬ [email protected]
     ├── [email protected]
     └─┬ [email protected]
       ├─┬ [email protected]
        └── [email protected]
       └─┬ [email protected]
         └── [email protected]
    ├─┬ [email protected]
     ├── [email protected]
     ├── [email protected]
     ├── [email protected]
     ├─┬ [email protected]
      └── [email protected]
     ├── [email protected]
     ├── [email protected]
     ├─┬ [email protected]
      └── [email protected]
     ├─┬ [email protected]
      ├─┬ [email protected]
       ├── [email protected]
       ├── [email protected]
       ├── [email protected]
       └── [email protected]
      ├─┬ [email protected]
       └── [email protected]
      └─┬ [email protected]
        ├── [email protected]
        ├─┬ [email protected]
         └── [email protected]
        ├── [email protected]
        └── [email protected]
     ├─┬ [email protected]
      ├── [email protected]
      ├── [email protected]
      ├── [email protected]
      └── [email protected]
     ├─┬ [email protected]
      ├── [email protected]
      ├─┬ [email protected]
       ├── [email protected]
       ├── [email protected]
       └── [email protected]
      └─┬ [email protected]
        ├── [email protected]
        ├── [email protected]
        ├── [email protected]
        ├─┬ [email protected]
         └── [email protected]
        ├── [email protected]
        ├─┬ [email protected]
         └── [email protected]
        ├── [email protected]
        ├── [email protected]
        └── [email protected]
     ├── [email protected]
     ├── [email protected]
     ├── [email protected]
     ├─┬ [email protected]
      └── [email protected]
     ├── [email protected]
     ├── [email protected]
     ├── [email protected]
     ├─┬ [email protected]
      └── [email protected]
     ├── [email protected]
     └── [email protected]
    ├─┬ [email protected]
     └─┬ [email protected]
       ├── [email protected]
       ├─┬ [email protected]
        └── [email protected]
       └─┬ [email protected]
         └── [email protected]
    └── [email protected]
   ├─┬ [email protected]
    └─┬ [email protected]
      └── [email protected]
   ├─┬ [email protected]
    ├── [email protected]
    ├── [email protected]
    └── [email protected]
   ├── [email protected]
   └─┬ [email protected]
     └── [email protected]
  └─┬ [email protected]
    ├─┬ [email protected]
     ├── [email protected]
     ├─┬ [email protected]
      ├── [email protected]
      ├── [email protected]
      ├── [email protected]
      ├── [email protected]
      └── [email protected]
     └── [email protected]
    ├── [email protected]
    ├─┬ [email protected]
     └── [email protected]
    └─┬ [email protected]
      └─┬ [email protected]
        └── [email protected]

Local Download

electron-quick-start master f8ae670 (2017-01-30)
Electron-quick-start-f8ae670.tar.gz (Download all npm packages with macOS)

See also

Favorite site

Quick start guide