1 | [![Electron Logo](https://electronjs.org/images/electron-logo.svg)](https://electronjs.org)
|
2 |
|
3 |
|
4 | [![CircleCI Build Status](https://circleci.com/gh/electron/electron/tree/master.svg?style=shield)](https://circleci.com/gh/electron/electron/tree/master)
|
5 | [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/4lggi9dpjc1qob7k/branch/master?svg=true)](https://ci.appveyor.com/project/electron-bot/electron-ljo26/branch/master)
|
6 | [![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron?type=dev)
|
7 |
|
8 | :memo: Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇠🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹 🇵🇱.
|
9 | View these docs in other languages at [electron/i18n](https://github.com/electron/i18n/tree/master/content/).
|
10 |
|
11 | The Electron framework lets you write cross-platform desktop applications
|
12 | using JavaScript, HTML and CSS. It is based on [Node.js](https://nodejs.org/) and
|
13 | [Chromium](https://www.chromium.org) and is used by the [Atom
|
14 | editor](https://github.com/atom/atom) and many other [apps](https://electronjs.org/apps).
|
15 |
|
16 | Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
|
17 | announcements.
|
18 |
|
19 | This project adheres to the Contributor Covenant
|
20 | [code of conduct](https://github.com/electron/electron/tree/master/CODE_OF_CONDUCT.md).
|
21 | By participating, you are expected to uphold this code. Please report unacceptable
|
22 | behavior to [coc@electronjs.org](mailto:coc@electronjs.org).
|
23 |
|
24 | ## Installation
|
25 |
|
26 | To install prebuilt Electron binaries, use [`npm`](https://docs.npmjs.com/).
|
27 | The preferred method is to install Electron as a development dependency in your
|
28 | app:
|
29 |
|
30 | ```sh
|
31 | npm install electron --save-dev
|
32 | ```
|
33 |
|
34 | For more installation options and troubleshooting tips, see
|
35 | [installation](docs/tutorial/installation.md). For info on how to manage Electron versions in your apps, see
|
36 | [Electron versioning](docs/tutorial/electron-versioning.md).
|
37 |
|
38 | ## Quick start & Electron Fiddle
|
39 |
|
40 | Use [`Electron Fiddle`](https://github.com/electron/fiddle)
|
41 | to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and
|
42 | to try out different versions of Electron. It's designed to make the start of your journey with
|
43 | Electron easier.
|
44 |
|
45 | Alternatively, clone and run the
|
46 | [electron/electron-quick-start](https://github.com/electron/electron-quick-start)
|
47 | repository to see a minimal Electron app in action:
|
48 |
|
49 | ```sh
|
50 | git clone https://github.com/electron/electron-quick-start
|
51 | cd electron-quick-start
|
52 | npm install
|
53 | npm start
|
54 | ```
|
55 |
|
56 | ## Resources for learning Electron
|
57 |
|
58 | - [electronjs.org/docs](https://electronjs.org/docs) - All of Electron's documentation
|
59 | - [electron/fiddle](https://github.com/electron/fiddle) - A tool to build, run, and package small Electron experiments
|
60 | - [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - A very basic starter Electron app
|
61 | - [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - Sample starter apps created by the community
|
62 | - [electron/simple-samples](https://github.com/electron/simple-samples) - Small applications with ideas for taking them further
|
63 | - [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - An Electron app that teaches you how to use Electron
|
64 | - [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - Small demo apps for the various Electron APIs
|
65 |
|
66 | ## Programmatic usage
|
67 |
|
68 | Most people use Electron from the command line, but if you require `electron` inside
|
69 | your **Node app** (not your Electron app) it will return the file path to the
|
70 | binary. Use this to spawn Electron from Node scripts:
|
71 |
|
72 | ```javascript
|
73 | const electron = require('electron')
|
74 | const proc = require('child_process')
|
75 |
|
76 | // will print something similar to /Users/maf/.../Electron
|
77 | console.log(electron)
|
78 |
|
79 | // spawn Electron
|
80 | const child = proc.spawn(electron)
|
81 | ```
|
82 |
|
83 | ### Mirrors
|
84 |
|
85 | - [China](https://npm.taobao.org/mirrors/electron)
|
86 |
|
87 | ## Documentation Translations
|
88 |
|
89 | Find documentation translations in [electron/i18n](https://github.com/electron/i18n).
|
90 |
|
91 | ## Contributing
|
92 |
|
93 | If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
|
94 |
|
95 | ## Community
|
96 |
|
97 | Info on reporting bugs, getting help, finding third-party tools and sample apps,
|
98 | and more can be found in the [support document](docs/tutorial/support.md#finding-support).
|
99 |
|
100 | ## License
|
101 |
|
102 | [MIT](https://github.com/electron/electron/blob/master/LICENSE)
|
103 |
|
104 | When using the Electron or other GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
|