electron / electron
Get started
From the repository's own files at da4c6886fbfd. Commands have not been executed.
Prerequisites
yarn@4.18.0from package.json
Commands
package.json| Task | Run | What it runs |
|---|---|---|
| start | yarn run start | node ./script/start.js |
| test | yarn run test | node ./script/spec-runner.js |
| lint | yarn run lint | node ./script/lint.js && npm run lint:fmt && npm run lint:docs && npm run lint:chromium-roller |
| typecheck | yarn run typecheck | node build/bundle/typecheck.mjs |
Install and use
README.mdTo install prebuilt Electron binaries, use npm.
The preferred method is to install Electron as a development dependency in your
app:
npm install electron --save-dev
For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.
Developing
CONTRIBUTING.mdIssues are created here.
- How to Contribute in Issues
- Asking for General Help
- Submitting a Bug Report
- Triaging a Bug Report
- Resolving a Bug Report
Issue Closure
Bug reports will be closed if the issue has been inactive and the latest affected version no longer receives support. At the moment, Electron maintains its three latest major versions, with a new major version being released every 8 weeks. (For more information on Electron's release cadence, see this blog post.)
If an issue has been closed and you still feel it's relevant, feel free to ping a maintainer or add a comment!
Languages
We accept issues in any language. When an issue is posted in a language besides English, it is acceptable and encouraged to post an English-translated copy as a reply. Anyone may post the translated reply. In most cases, a quick pass through translation software is sufficient. Having the original text as well as the translation can help mitigate translation errors.
Responses to posted issues may or may not be in the original language.
Also note: Could not capture yarn.lock: source unavailable or larger than the capture limit. Open its source link to check setup.