818ba0d1ae
Added a warning for Windows 10 users facing npm errors. Most of the times that's the problem |
||
|---|---|---|
| .gitignore | ||
| LICENSE.md | ||
| README.md | ||
| index.html | ||
| main.js | ||
| package.json | ||
| renderer.js | ||
README.md
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 within the Electron documentation.
Use this app along with the Electron API Demos app for API code examples to help you get started.
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.
You can learn more about each of these components within the Quick Start Guide.
To Use
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# 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
Learn more about Electron and its API in the documentation.
Warning: Windows 10 users might encounter some errors while running npm start from Linux Bash for Windows. The reason for this is that Electron is a GUI application, but Linux bash for Windows is just a headless VM without any GUI ( explained here ).
A temporary workaround is getting NodeJS for Windows and use the node cmd.
Other Example Apps
For more example apps, see the list of boilerplates created by the awesome electron community.