electron/README.md

111 lines
4.9 KiB
Markdown
Raw Normal View History

[![Electron Logo](https://electronjs.org/images/electron-logo.svg)](https://electronjs.org)
2015-04-23 20:46:48 +00:00
2016-04-04 19:18:37 +00:00
[![Travis Build Status](https://travis-ci.org/electron/electron.svg?branch=master)](https://travis-ci.org/electron/electron)
2017-03-14 17:13:53 +00:00
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/bc56v83355fi3369/branch/master?svg=true)](https://ci.appveyor.com/project/electron-bot/electron/branch/master)
[![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron?type=dev)
2015-06-29 23:46:22 +00:00
[![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/)
:memo: Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹.
View these docs in other languages at [electron/electron-i18n](https://github.com/electron/electron-i18n/tree/master/content/).
2017-08-08 17:55:09 +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](https://electronjs.org/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.
This project adheres to the Contributor Covenant
2017-08-08 17:18:40 +00:00
[code of conduct](https://github.com/electron/electron/tree/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable
2017-08-08 17:18:40 +00:00
behavior to [electron@github.com](mailto:electron@github.com).
2015-07-08 20:29:24 +00:00
2017-08-08 17:18:40 +00:00
## Installation
2013-04-12 01:46:58 +00:00
2017-08-08 17:18:40 +00:00
To install prebuilt Electron binaries, use [`npm`](https://docs.npmjs.com/).
The preferred method is to install Electron as a development dependency in your
app:
```sh
2017-08-08 17:18:40 +00:00
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](https://electronjs.org/docs/tutorial/electron-versioning).
2017-08-08 17:18:40 +00:00
For more installation options and troubleshooting tips, see
[installation](https://electronjs.org/docs/tutorial/installation).
2017-08-08 17:18:40 +00:00
## Quick start
Clone and run the
2017-08-08 17:18:40 +00:00
[electron/electron-quick-start](https://github.com/electron/electron-quick-start)
repository to see a minimal Electron app in action:
```sh
2017-08-08 17:18:40 +00:00
git clone https://github.com/electron/electron-quick-start
cd electron-quick-start
npm install
npm start
```
2017-11-19 17:51:03 +00:00
## Resources for learning Electron
- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation
2017-08-08 17:18:40 +00:00
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community
2017-08-08 17:18:40 +00:00
- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs
2015-01-19 14:30:33 +00:00
2017-08-08 17:18:40 +00:00
## 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:
2015-01-19 14:30:33 +00:00
2017-08-08 17:18:40 +00:00
```javascript
const electron = require('electron')
const proc = require('child_process')
2013-04-12 01:46:58 +00:00
2017-08-08 17:18:40 +00:00
// will print something similar to /Users/maf/.../Electron
console.log(electron)
// spawn Electron
const child = proc.spawn(electron)
```
### Mirrors
- [China](https://npm.taobao.org/mirrors/electron)
2014-05-14 18:32:24 +00:00
## Documentation translations
2015-08-23 15:19:37 +00:00
2017-11-12 16:03:43 +00:00
Find documentation translations in [electron/electron-18n](https://github.com/electron/electron-i18n).
2015-08-23 15:19:37 +00:00
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
locations:
2015-11-03 05:16:12 +00:00
- [`electron`](http://discuss.atom.io/c/electron) category on the Atom
forums
- `#atom-shell` channel on Freenode
- [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack
2017-05-05 16:34:53 +00:00
- [`electron-ru`](https://telegram.me/electron_ru) *(Russian)*
2015-12-02 15:27:23 +00:00
- [`electron-br`](https://electron-br.slack.com) *(Brazilian Portuguese)*
- [`electron-kr`](https://electron-kr.github.io/electron-kr) *(Korean)*
2016-12-25 09:07:25 +00:00
- [`electron-jp`](https://electron-jp.slack.com) *(Japanese)*
- [`electron-tr`](http://electron-tr.herokuapp.com) *(Turkish)*
- [`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)
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 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).