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.

41 lines
1.9 KiB

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