Clone to try a simple Electron app

Jessica Lord 8ff9e5c25b Merge pull request #27 from clemens-tolboom/clemens-tolboom-patch-1 3 years ago
.gitignore 70779efcf4 Add gitignore 3 years ago
LICENSE.md 93394cf659 Change license to CC0 3 years ago
README.md 8a60d001e4 Remove $ in code example 3 years ago
index.html 575b1bcf73 Update index.html 3 years ago
main.js d709bb0885 Extract createWindow helper, re org 3 years ago
package.json 3254071d58 Fix dependencies version 3 years ago

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)