Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.59 KB

README.md

File metadata and controls

38 lines (25 loc) · 1.59 KB
Raw

electron-quick-start

Clone and run for a quick way to see an 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 and run the app
npm install && npm start

Learn more about Electron and its API in the documentation.

Other Example Apps

For more example apps, see the list of boilerplates created by the awesome electron community.

License CC0 (Public Domain)