You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Alex Anderson 07200177f5 Comment out enabling dev tools 9 years ago
.gitignore Add gitignore 10 years ago
LICENSE.md Change license to CC0 10 years ago
README.md Fix Readme Quick Start Guide links 9 years ago
index.html Use full Node.js name 9 years ago
main.js Comment out enabling dev tools 9 years ago
package.json clean up package.json 9 years ago
renderer.js Add comment 10 years ago

README.md

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

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 1.0 (Public Domain)