README.md

   1 # electron-quick-start
   2
   3 **Clone and run for a quick way to see Electron in action.**
   4
   5 This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation.
   6
   7 **Use this app along with the [Electron API Demos](http://electron.atom.io/#get-started) app for API code examples to help you get started.**
   8
   9 A basic Electron application needs just these files:
  10
  11 - `package.json` - Points to the app's main file and lists its details and dependencies.
  12 - `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
  13 - `index.html` - A web page to render. This is the app's **renderer process**.
  14
  15 You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start).
  16
  17 ## To Use
  18
  19 To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
  20
  21 ```bash
  22 # Clone this repository
  23 git clone https://github.com/electron/electron-quick-start
  24 # Go into the repository
  25 cd electron-quick-start
  26 # Install dependencies
  27 npm install
  28 # Run the app
  29 npm start
  30 ```
  31
  32 Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
  33
  34 ## Resources for Learning Electron
  35
  36 - [electron.atom.io/docs](http://electron.atom.io/docs) - all of Electron's documentation
  37 - [electron.atom.io/community/#boilerplates](http://electron.atom.io/community/#boilerplates) - sample starter apps created by the community
  38 - [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
  39 - [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
  40 - [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
  41 - [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs
  42
  43 ## License
  44
  45 [CC0 1.0 (Public Domain)](LICENSE.md)