Need help with electron-quick-start?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

electron
8.1K Stars 4.0K Forks Creative Commons Zero v1.0 Universal 277 Commits 11 Opened issues

Description

Clone to try a simple Electron app

Services available

!
?

Need anything else?

Contributors list

No Data

electron-quick-start

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

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.

To Use

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/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use

node
from the command prompt.

Resources for Learning Electron

License

CC0 1.0 (Public Domain)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.