electron/minimal-repro

minimal-repro

Quickly create and share examples of Electron app behaviors or bugs.

[!NOTE] This repro was renamed from electron-quick-start to clarify its purpose as a repro template. If you're looking to boostrap a new Electron app, check out the Electron Forge docs instead to get started!

Creating a minimal reproduction (or "minimal repro") is essential when troubleshooting Electron apps. By stripping away everything except the code needed to demonstrate a specific behavior or bug, it becomes easier for others to understand, debug, and fix issues. This focused approach saves time and ensures that everyone involved is looking at exactly the same problem without distractions.

A basic Electron application contains:

• 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.

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/minimal-repro
# Go into the repository
cd minimal-repro
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Resources for Learning Electron

• electronjs.org/docs - all of Electron's documentation
• Electron Fiddle - Electron Fiddle, an app to test small Electron experiments
• Electron Forge - Looking to bootstrap a new Electron app? Check out the Electron Forge docs to get started

License

CC0 1.0 (Public Domain)