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.

40 lines
1.7 KiB

1 year 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. - `preload.js` - A content script that runs before the renderer process loads.
  9. You can learn more about each of these components in depth within the [Tutorial](https://electronjs.org/docs/latest/tutorial/tutorial-prerequisites).
  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
  18. npm install
  19. # Run the app
  20. npm start
  21. ```
  22. 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.
  23. ## Resources for Learning Electron
  24. - [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation
  25. - [Electron Fiddle](https://electronjs.org/fiddle) - Electron Fiddle, an app to test small Electron experiments
  26. ## License
  27. [CC0 1.0 (Public Domain)](LICENSE.md)