https://github.com/electron/electron-quick-start

Clone to try a simple Electron app
https://github.com/electron/electron-quick-start

Last synced: 4 days ago
JSON representation

Clone to try a simple Electron app

• Host: GitHub
• URL: https://github.com/electron/electron-quick-start
• Owner: electron
• License: cc0-1.0
• Created: 2015-10-16T23:56:39.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T14:02:53.000Z (about 2 months ago)
• Last Synced: 2024-10-29T10:49:07.764Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://electronjs.org/docs/latest/tutorial/quick-start
• Size: 1.17 MB
• Stars: 11,171
• Watchers: 313
• Forks: 4,942
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome - electron/electron-quick-start - Clone to try a simple Electron app (Javascript / Miscs)
• awesome-list - electron-quick-start - Clone to try a simple Electron app. (Desktop App Development / Data Management)
• awesome-electron - electron-quick-start - Clone the repo to try a simple app. (Boilerplates / Samples)
• awesome-electron - electron-quick-start - Clone the repo to try a simple app.  (Boilerplates / Tools)
• awesome-electron-zh - electron-quick-start - Clone the repo to try a simple app. (Boilerplates / Samples)

README

        
# electron-quick-start

**Clone and run for a quick way to see Electron in action.**

This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/latest/tutorial/quick-start) within the Electron documentation.

A basic Electron application needs just these files:

- `package.json` - Points to the app's main file and lists its details and dependencies.

- `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**.

- `preload.js` - A content script that runs before the renderer process loads.

You can learn more about each of these components in depth within the [Tutorial](https://electronjs.org/docs/latest/tutorial/tutorial-prerequisites).

## 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

git clone https://github.com/electron/electron-quick-start

# Go into the repository

cd electron-quick-start

# Install dependencies

npm install

# Run the app

npm start

```

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.

## Resources for Learning Electron

- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation

- [Electron Fiddle](https://electronjs.org/fiddle) - Electron Fiddle, an app to test small Electron experiments

## License

[CC0 1.0 (Public Domain)](LICENSE.md)