You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
1.6 KiB

10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
  1. # electron-quick-start
  2. **Clone and run for a quick way to see an Electron in action.**
  3. This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/latest/tutorial/quick-start) within the Electron documentation.
  4. **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.**
  5. A basic Electron application needs just these files:
  6. - `package.json` - Points to the app's main file and lists its details and dependencies.
  7. - `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
  8. - `index.html` - A web page to render. This is the app's **renderer process**.
  9. You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/latest/tutorial/quick-start).
  10. ## To Use
  11. 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:
  12. ```bash
  13. # Clone this repository
  14. git clone https://github.com/electron/electron-quick-start
  15. # Go into the repository
  16. cd electron-quick-start
  17. # Install dependencies and run the app
  18. npm install && npm start
  19. ```
  20. Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/latest).
  21. ## Other Example Apps
  22. For more example apps, see the
  23. [list of boilerplates](http://electron.atom.io/community/#boilerplates)
  24. created by the awesome electron community.
  25. #### License [CC0 (Public Domain)](LICENSE.md)