Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.2 KB

README.md

File metadata and controls

30 lines (20 loc) · 1.2 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.

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)