2015-10-17 07:56:39 +08:00
# electron-quick-start
2015-10-17 08:52:00 +08:00
2016-11-23 05:47:50 +08:00
**Clone and run for a quick way to see Electron in action.**
2015-10-17 08:52:00 +08:00
2016-12-24 03:21:36 +08:00
This is a minimal Electron application based on the [Quick Start Guide ](http://electron.atom.io/docs/tutorial/quick-start ) within the Electron documentation.
2015-10-17 08:52:00 +08:00
2016-05-11 14:48:52 +08:00
**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.**
2015-10-21 15:55:42 +08:00
A basic Electron application needs just these files:
2015-10-17 08:52:00 +08:00
- `package.json` - Points to the app's main file and lists its details and dependencies.
2016-04-21 06:18:14 +08:00
- `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** .
2015-10-17 08:52:00 +08:00
2016-12-24 03:21:36 +08:00
You can learn more about each of these components within the [Quick Start Guide ](http://electron.atom.io/docs/tutorial/quick-start ).
2015-10-17 08:52:00 +08:00
## To Use
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:
```bash
# Clone this repository
2016-04-05 04:00:14 +08:00
git clone https://github.com/electron/electron-quick-start
2015-10-17 08:52:00 +08:00
# Go into the repository
2016-01-01 23:15:54 +08:00
cd electron-quick-start
2016-11-01 01:38:04 +08:00
# Install dependencies
npm install
# Run the app
npm start
2015-10-17 08:52:00 +08:00
```
2016-12-21 23:19:32 +08:00
Learn more about Electron and its API in the [documentation ](http://electron.atom.io/docs/ ).
2015-10-17 08:52:00 +08:00
2017-02-16 17:32:58 +08:00
---
2017-04-05 23:09:02 +08:00
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 Command Prompt
2017-02-16 17:32:58 +08:00
2016-07-15 06:02:18 +08:00
## Other Example Apps
For more example apps, see the
[list of boilerplates ](http://electron.atom.io/community/#boilerplates )
created by the awesome electron community.
2016-10-05 00:37:02 +08:00
#### License [CC0 1.0 (Public Domain)](LICENSE.md)