Build cross platform desktop apps with JavaScript, HTML, and CSS
C++ JavaScript Objective-C++ Python Objective-C HTML Other
Switch branches/tags
Latest commit 8a4c76d Jan 19, 2018 @felixrieseberg felixrieseberg committed with codebytere docs: Document custom installation (#11640)
* 📝 Document custom installation

* ❤️ Implement feedback

* 🔧 Fix linting errors
Permalink
Failed to load latest commit information.
.circleci Set DISPLAY variable for xvfb Jan 17, 2018
.github feat: Allow testing of single spec modules (#11409) Dec 28, 2017
atom Fix macos Full Screen Toggle menu item label (#11633) Jan 19, 2018
brightray Fix cpplint warning Jan 3, 2018
chromium_src posix: Fix assertion when freeing ProcessSingleton Jan 3, 2018
default_app Replace default_app icon Dec 7, 2017
docs-translations Merge https://github.com/kstar0714/electron Nov 22, 2017
docs docs: Document custom installation (#11640) Jan 19, 2018
lib Throw when inAppPurchase is used on unsupported platforms Jan 10, 2018
npm revert electron-download dependency to ^3.0.1 Nov 3, 2017
script Merge pull request #11487 from electron/circleci-cross-arch-testing Jan 8, 2018
spec Replace arrow function Jan 17, 2018
tools Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
vendor Update gyp: Add Visual Studio 2017 support Jan 17, 2018
.clang-format Add clang-format config file. Oct 4, 2016
.dockerignore Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
.gitignore Ignore all npmrc and package-lock Dec 4, 2017
.gitmodules Move brightray submodules to root vendor May 10, 2017
.node-version Bump node version number Sep 14, 2017
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. Nov 20, 2017
.travis.yml Add arm64 task in travis ci Aug 22, 2017
CODE_OF_CONDUCT.md fix word CODE_OF_CONDUCT.md Nov 22, 2017
CONTRIBUTING.md Update CONTRIBUTING.md with link to development docs (#11529) Jan 19, 2018
Dockerfile Enable testing with python-dbusmock Dec 5, 2017
Dockerfile.arm64 Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
Dockerfile.armv7 Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
Dockerfile.circleci Enable testing with python-dbusmock Dec 5, 2017
Jenkinsfile Add 1 hour timeout Dec 4, 2017
LICENSE Update license year Dec 31, 2017
README.md Fix 'electron-versioning' link in README.md Dec 13, 2017
SECURITY.md Add SECURITY.md Jan 30, 2017
common.gypi Fix "nghttp2" build Nov 24, 2017
electron.gyp Add in-app purchase for MacOS Jan 10, 2018
features.gypi Add enable_osr build flag Jun 28, 2017
filenames.gypi Reorgnize the platform-specific files Jan 10, 2018
package.json Add executable test to package.json Dec 13, 2017
toolchain.gypi Some compiler flags are clang only Nov 21, 2017

README.md

Electron Logo

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

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹. View these docs in other languages at electron/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 electron@github.com.

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 as Electron does not follow semantic versioning. 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

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/electron-i18n.

Community

You can ask questions and interact with the community in the following locations:

Check out awesome-electron for a community maintained list of useful example apps, tools and resources.

License

MIT

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