2015-04-28 14:48:54 +00:00
|
|
|
[](http://electron.atom.io/)
|
2015-04-23 20:46:48 +00:00
|
|
|
|
2016-04-04 19:18:37 +00:00
|
|
|
[](https://travis-ci.org/electron/electron)
|
2016-05-02 15:59:25 +00:00
|
|
|
[](https://ci.appveyor.com/project/Atom/electron)
|
2016-10-12 20:17:26 +00:00
|
|
|
[](https://david-dm.org/electron/electron?type=dev)
|
2015-06-29 23:46:22 +00:00
|
|
|
[](http://atom-slack.herokuapp.com/)
|
|
|
|
|
|
2016-10-26 06:09:36 +00:00
|
|
|
:memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/README.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/README.md) | [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR/project/README.md) | [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW/project/README.md)
|
2016-09-06 21:58:50 +00:00
|
|
|
|
2015-04-08 17:16:10 +00:00
|
|
|
The Electron framework lets you write cross-platform desktop applications
|
2015-11-03 17:13:48 +00:00
|
|
|
using JavaScript, HTML and CSS. It is based on [Node.js](https://nodejs.org/) and
|
2016-05-24 17:20:52 +00:00
|
|
|
[Chromium](http://www.chromium.org) and is used by the [Atom
|
|
|
|
|
editor](https://github.com/atom/atom) and many other [apps](http://electron.atom.io/apps).
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-04-24 00:00:04 +00:00
|
|
|
Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
|
|
|
|
|
announcements.
|
|
|
|
|
|
2015-12-04 00:06:58 +00:00
|
|
|
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
|
|
|
|
|
By participating, you are expected to uphold this code. Please report unacceptable
|
2016-05-24 17:20:52 +00:00
|
|
|
behavior to electron@github.com.
|
2015-07-08 20:29:24 +00:00
|
|
|
|
2014-05-04 12:58:59 +00:00
|
|
|
## Downloads
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2016-11-14 21:52:07 +00:00
|
|
|
To install prebuilt Electron binaries, use
|
2016-12-18 04:35:06 +00:00
|
|
|
[`npm`](https://docs.npmjs.com/):
|
2015-04-17 18:25:06 +00:00
|
|
|
|
2015-04-29 17:56:31 +00:00
|
|
|
```sh
|
2015-04-17 18:25:06 +00:00
|
|
|
# Install as a development dependency
|
2016-08-14 04:42:26 +00:00
|
|
|
npm install electron --save-dev
|
2016-11-14 21:52:07 +00:00
|
|
|
|
|
|
|
|
# Install the `electron` command globally in your $PATH
|
|
|
|
|
npm install electron -g
|
2015-04-17 18:25:06 +00:00
|
|
|
```
|
|
|
|
|
|
2016-11-14 21:52:07 +00:00
|
|
|
See the [releases page](https://github.com/electron/electron/releases) for
|
|
|
|
|
prebuilt binaries, debug symbols, and more.
|
|
|
|
|
|
2015-01-19 14:30:33 +00:00
|
|
|
### Mirrors
|
|
|
|
|
|
2015-05-10 08:15:12 +00:00
|
|
|
- [China](https://npm.taobao.org/mirrors/electron)
|
2015-01-19 14:30:33 +00:00
|
|
|
|
2014-05-05 18:56:35 +00:00
|
|
|
## Documentation
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2014-05-07 05:06:35 +00:00
|
|
|
Guides and the API reference are located in the
|
2016-03-31 23:51:42 +00:00
|
|
|
[docs](https://github.com/electron/electron/tree/master/docs) directory. It also
|
2015-04-16 03:10:24 +00:00
|
|
|
contains documents describing how to build and contribute to Electron.
|
2014-05-14 18:32:24 +00:00
|
|
|
|
2015-08-23 15:19:37 +00:00
|
|
|
## Documentation Translations
|
|
|
|
|
|
2016-03-31 23:51:42 +00:00
|
|
|
- [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR)
|
|
|
|
|
- [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR)
|
|
|
|
|
- [Japanese](https://github.com/electron/electron/tree/master/docs-translations/jp)
|
|
|
|
|
- [Spanish](https://github.com/electron/electron/tree/master/docs-translations/es)
|
|
|
|
|
- [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN)
|
|
|
|
|
- [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW)
|
2016-04-25 21:49:34 +00:00
|
|
|
- [Turkish](https://github.com/electron/electron/tree/master/docs-translations/tr-TR)
|
2016-03-31 23:51:42 +00:00
|
|
|
- [Ukrainian](https://github.com/electron/electron/tree/master/docs-translations/uk-UA)
|
|
|
|
|
- [Russian](https://github.com/electron/electron/tree/master/docs-translations/ru-RU)
|
|
|
|
|
- [French](https://github.com/electron/electron/tree/master/docs-translations/fr-FR)
|
2015-08-23 15:19:37 +00:00
|
|
|
|
2015-10-19 22:52:02 +00:00
|
|
|
## Quick Start
|
|
|
|
|
|
2016-04-04 19:18:37 +00:00
|
|
|
Clone and run the [`electron/electron-quick-start`](https://github.com/electron/electron-quick-start)
|
2015-10-19 22:52:02 +00:00
|
|
|
repository to see a minimal Electron app in action.
|
|
|
|
|
|
2014-05-14 18:32:24 +00:00
|
|
|
## Community
|
|
|
|
|
|
2015-10-03 05:42:34 +00:00
|
|
|
You can ask questions and interact with the community in the following
|
2015-09-09 18:34:20 +00:00
|
|
|
locations:
|
2015-11-03 05:16:12 +00:00
|
|
|
- [`electron`](http://discuss.atom.io/c/electron) category on the Atom
|
2015-09-09 18:34:20 +00:00
|
|
|
forums
|
|
|
|
|
- `#atom-shell` channel on Freenode
|
|
|
|
|
- [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack
|
2015-12-02 15:27:23 +00:00
|
|
|
- [`electron-br`](https://electron-br.slack.com) *(Brazilian Portuguese)*
|
2016-01-20 10:05:35 +00:00
|
|
|
- [`electron-kr`](http://www.meetup.com/electron-kr/) *(Korean)*
|
2016-02-16 17:20:38 +00:00
|
|
|
- [`electron-jp`](https://electron-jp-slackin.herokuapp.com/) *(Japanese)*
|
2016-06-22 07:11:13 +00:00
|
|
|
- [`electron-tr`](http://www.meetup.com/Electron-JS-Istanbul/) *(Turkish)*
|
2016-07-13 07:07:46 +00:00
|
|
|
- [`electron-id`](https://electron-id.slack.com) *(Indonesia)*
|
2016-06-22 08:02:14 +00:00
|
|
|
|
2015-10-03 05:42:34 +00:00
|
|
|
Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron)
|
2015-09-09 18:34:20 +00:00
|
|
|
for a community maintained list of useful example apps, tools and resources.
|
2016-10-01 03:33:51 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2016-11-07 22:26:21 +00:00
|
|
|
[MIT](https://github.com/electron/electron/blob/master/LICENSE)
|
2016-11-07 20:08:11 +00:00
|
|
|
|
2016-11-07 22:26:21 +00:00
|
|
|
When using the Electron or other GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
|
