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…

Что это такое?Минимальный шаблон приложения на Electron для создания и распространения небольших воспроизведений поведения или ошибок приложений Electron, чтобы другие могли отлаживать ту же самую узкую проблему без лишнего шума.
Это стартовый набор для новых приложений или просто шаблон для воспроизведения ошибок?Это именно шаблон для воспроизведения (ранее назывался electron-quick-start) для выделения и демонстрации проблем, а не инструмент для создания новых приложений Electron.
Как это запустить?Клонируйте репозиторий, затем запустите его из командной строки с помощью npm/Node.js; скрипт start в package.json выполняет 'electron .'
Нужно ли что-то установить перед клонированием?На компьютере должны быть установлены Git и Node.js (который включает npm).
Стоит ли использовать это для создания нового проекта Electron?Нет, это предназначено только для воспроизведения ошибок. Для создания нового приложения лучше использовать Electron Forge.
Работает ли это на Windows, macOS и Linux?Да, поскольку это обычное приложение Electron, оно работает на всех платформах; в README отдельно указано ограничение для пользователей Linux Bash в Windows.
Из каких файлов состоит это минимальное приложение?Оно содержит package.json (метаданные приложения и зависимости), main.js (основной процесс, который создаёт окно браузера), index.html (страница рендерера) и preload.js (скрипт, который выполняется до загрузки рендерера).
Creator
electron
Size
1.4 MB
Stars
11.4K
Updated
CommitOct 16
Age
11y
Commits · 90 Days