Go to file
Clemens Tolboom 8a60d001e4 Remove $ in code example
Let's make this copy/paste able.
2016-01-01 16:15:54 +01:00
.gitignore Add gitignore 2015-10-16 17:00:08 -07:00
LICENSE.md Change license to CC0 2015-11-23 06:47:37 +09:00
README.md Remove $ in code example 2016-01-01 16:15:54 +01:00
index.html Update index.html 2015-11-23 21:32:52 -05:00
main.js Remove call to crashReporter.start() 2015-12-16 10:17:56 -08:00
package.json Fix dependencies version 2015-12-15 14:19:48 +09:00

README.md

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.

A basic Electron application needs just these files:

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

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/atom/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.

License CC0 (Public Domain)