No description
Find a file
Samuel Attard 238ea29fa8
chore: update package.json scripts for gn build and automated releases (#14612)
* Removes un-used and non-functional code coverage helpers
* Removes un-used release script aliases
* Moves TLS to a lib folder for cleaner directory structure
* Implements start.py as start.js for the GN build
* Adds a re-usable getElectronExec helper for future scripts
* Refactors spec runner to use the helper
2018-09-14 02:57:39 +10:00
.circleci chore: make the 'npm run test' command work out of the box (#14602) 2018-09-14 01:30:12 +10:00
.github chore: ask for specific info in bug templates (#14229) 2018-08-22 08:21:54 -07:00
.vsts ci: set up a lint job (#14536) 2018-09-11 14:28:18 -07:00
atom fix: re-enable high-dpi support on windows (#14596) 2018-09-13 10:40:29 -05:00
brightray chore: fix linting error on master (#14609) 2018-09-14 00:28:47 +10:00
build build: use default value of the enable_widevine flag 2018-09-11 20:24:03 +02:00
chromium_src build: remove duplicate devtools sources (#14522) 2018-09-12 08:45:08 -05:00
components/pepper_flash Rename buildflag_headers for consistency 2018-09-11 20:21:32 +02:00
default_app Revert "sec: deprecate some webPreference defaults to be secure-by-default (#14284)" (#14380) 2018-08-30 09:57:49 +12:00
docs Merge pull request #14600 from electron/media-permission 2018-09-13 10:39:08 -04:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib refactor: remove unused, duplicated code in deprecate module (#14579) 2018-09-12 17:13:22 -05:00
native_mate [wip] build: try building node with GN 2018-08-10 10:06:27 -07:00
npm fix: electron path for postinstall (#14177) 2018-08-19 09:40:12 -07:00
script chore: update package.json scripts for gn build and automated releases (#14612) 2018-09-14 02:57:39 +10:00
spec fix: update node ref to fix patch handling unhandled rejections (#14603) 2018-09-13 16:32:49 +10:00
tools feat: Remove legacy helpers (Electron Helper EH/NP) (#14436) 2018-09-03 21:37:15 -05:00
vendor build: remove gyp build files (#14097) 2018-09-09 10:15:32 +09:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.env.example clarify purpose of .env.example 2018-07-11 12:55:15 -07:00
.gitignore chore: make the 'npm run test' command work out of the box (#14602) 2018-09-14 01:30:12 +10:00
.gitmodules build: remove gyp build files (#14097) 2018-09-09 10:15:32 +09:00
.remarkrc
appveyor.yml chore: make the 'npm run test' command work out of the box (#14602) 2018-09-14 01:30:12 +10:00
BUILD.gn fix: re-enable high-dpi support on windows (#14596) 2018-09-13 10:40:29 -05:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
DEPS chore: dont install spec deps on sync needlessly (#14614) 2018-09-14 02:51:21 +10:00
Dockerfile Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
Dockerfile.arm64 Newer CI images (#12188) 2018-03-08 22:07:50 -05:00
Dockerfile.arm64v8 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.armv7 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.circleci Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
electron.gyp build: remove gyp build files (#14097) 2018-09-09 10:15:32 +09:00
electron_paks.gni build: remove duplicate devtools sources (#14522) 2018-09-12 08:45:08 -05:00
filenames.gni build: remove duplicate devtools sources (#14522) 2018-09-12 08:45:08 -05:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package-lock.json chore: update request dep to remove warning about cryptiles (#14610) 2018-09-14 01:35:18 +10:00
package.json chore: update package.json scripts for gn build and automated releases (#14612) 2018-09-14 02:57:39 +10:00
README.md docs: Add Electron Fiddle to the readme (#14396) 2018-08-31 22:56:55 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
vsts-gn.yml ci: do not use scripts and binaries from the libcc repo 2018-09-12 13:08:17 +02:00

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status Join the Electron Community on Slack

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹. View these docs in other languages at electron/i18n.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Atom editor and many other apps.

Follow @ElectronJS on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc@electronjs.org.

Installation

To 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 [--save-exact]

The --save-exact flag is recommended for Electron prior to version 2, as it does not follow semantic versioning. As of version 2.0.0, Electron follows semver, so you don't need --save-exact flag. For info on how to manage Electron versions in your apps, see Electron versioning.

For more installation options and troubleshooting tips, see installation.

Quick start & Electron Fiddle

Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and to try out different versions of Electron. It's designed to make the start of your journey with Electron easier.

Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-start
cd electron-quick-start
npm install
npm start

Resources for learning Electron

Programmatic usage

Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

const electron = require('electron')
const proc = require('child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

Mirrors

Documentation Translations

Find documentation translations in electron/i18n.

Community

Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found in the support document.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.