minimal-repro README

The project's README from github.com/electron/minimal-repro. As one markdown file: README.md.

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:

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

License

CC0 1.0 (Public Domain)

minimal-repro (electron/minimal-repro)

Searching Database…

11.4K ·GitHub
Minimal-repro
What is this?A minimal Electron app template for creating and sharing small reproductions of Electron app behaviors or bugs, so others can debug the exact same focused problem without extra noise.
Is this a starter kit for new apps or just a bug repro template?It is specifically a repro template (formerly named electron-quick-start) for isolating and demonstrating issues, not a bootstrap tool for new Electron apps.
How do I get it running?Clone the repository, then run it from the command line using npm/Node.js; the package.json start script runs 'electron .'
Do I need anything installed before cloning this?You need Git and Node.js (which includes npm) installed on your computer.
Should I use this to start a brand-new Electron project?No, this is meant only for bug repros. For bootstrapping a new app you should use Electron Forge instead.
Does it run on Windows, macOS, and Linux?Yes, since it's a standard Electron app it runs cross-platform; the README specifically notes a caveat for Linux Bash on Windows users.
What files make up this minimal app?It contains package.json (app metadata and dependencies), main.js (the main process that creates the browser window), index.html (the renderer page), and preload.js (a script that runs before the renderer loads).
What are similar projects?electron-react-boilerplate, yeoman, agentic-playwright, awesome-electron, electron, open-saas, angular-seed, electron-vue
Which topics is it in?boilerplate, template, debugging, electron, html, npm, desktop-app, tool, nodejs, javascript, cross-platform, developer-tools
Creator
electron
Size
1.4 MB
Stars
11.4K
Updated
CommitOct 16
Age
11y
Commits · 90 Days