Nightingale Posing Mischievously

    electron
    TypeScript icon, indicating that this package has built-in type declarations

    1.8.8 • Public • Published

    Electron Logo

    Travis Build Status AppVeyor 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 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 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.

    Keywords

    Install

    npm i electron@1.8.8

    Version

    1.8.8

    License

    MIT

    Unpacked Size

    365 kB

    Total Files

    7

    Last publish

    Collaborators

    • electron
    • electron-nightly