Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/electron/electron-api-demos
Explore the Electron APIs
https://github.com/electron/electron-api-demos
Last synced: 3 months ago
JSON representation
Explore the Electron APIs
- Host: GitHub
- URL: https://github.com/electron/electron-api-demos
- Owner: electron
- License: mit
- Archived: true
- Created: 2015-10-16T17:59:08.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T14:34:33.000Z (about 2 years ago)
- Last Synced: 2024-04-14T03:56:18.520Z (8 months ago)
- Language: HTML
- Homepage: http://electronjs.org/#get-started
- Size: 5.41 MB
- Stars: 10,242
- Watchers: 493
- Forks: 2,121
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - Electron API Demos - Explore the Electron APIs. (Desktop App Development / Data Management)
README
# 
Electron API Demos
[](https://travis-ci.org/electron/electron-api-demos)
[](http://standardjs.com)
This is a desktop app that interactively and with sample code demonstrates core features of the [Electron](http://electronjs.org) API. It's built with Electron, too, of course. This app works on Windows, macOS and Linux operating systems.
Use this app to see what you can do with Electron and use the source code to learn how to create a basic Electron app.
---
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
behavior to [[email protected]](mailto:[email protected]).
Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
announcements. Visit the [electron website](http://electronjs.org).
## Using
You can [download the latest release](https://github.com/electron/electron-api-demos/releases) for your operating system or build it yourself (see below).
## Building
You'll need [Node.js](https://nodejs.org) installed on your computer in order to build this app.
```bash
$ git clone https://github.com/electron/electron-api-demos
$ cd electron-api-demos
$ npm install
$ npm start
```
If you don't wish to clone, you can [download the source code](https://github.com/electron/electron-api-demos/archive/master.zip).
For easier developing you can launch the app in fullscreen with DevTools open:
```bash
$ npm run dev
```
## Extending
[Read the docs](docs.md) to learn more about how this app is built or how to [add a new demo](docs.md#add-a-section-or-demo).
## Translations
* Simplified Chinese translation of this app is available at [`demopark/electron-api-demos-Zh_CN`](https://github.com/demopark/electron-api-demos-Zh_CN).
* Traditional Chinese translation of this app is available at [`CalvertYang/electron-api-demos-zh-Hant`](https://github.com/CalvertYang/electron-api-demos-zh-Hant).
* Japanese translation of this app is available at [`LeeDDHH/electron-api-demos-ja`](https://github.com/LeeDDHH/electron-api-demos-ja).
Note: these versions are maintained by outside contributors and may not always be in sync with this version.