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.

45 lines
2.3 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/tutorial/quick-start) within the Electron documentation.
  4. **Use this app along with the [Electron API Demos](https://electronjs.org/#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](https://electronjs.org/docs/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
  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. - [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community
  26. - [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
  27. - [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
  28. - [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
  29. - [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs
  30. ## License
  31. [CC0 1.0 (Public Domain)](LICENSE.md)