electron-api-demos README

The project's README from github.com/electron/electron-api-demos. As one markdown file: README.md.

Electron API Demos icon Electron API Demos

Build Status JavaScript Standard Style

This is a desktop app that interactively and with sample code demonstrates core features of the Electron 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.

Electron API Demos Screenshots

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Follow @ElectronJS on Twitter for important announcements. Visit the electron website.

Using

You can download the latest release for your operating system or build it yourself (see below).

Building

You'll need Node.js installed on your computer in order to build this app.

$ 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.

For easier developing you can launch the app in fullscreen with DevTools open:

$ npm run dev

Extending

Read the docs to learn more about how this app is built or how to add a new demo.

Translations

Note: these versions are maintained by outside contributors and may not always be in sync with this version.

electron-api-demos (electron/electron-api-demos)

Searching Database…

10.2K ·GitHub
Electron-api-demos
archived
What is this?A desktop app that interactively demonstrates core Electron APIs with live sample code, so you can see what each API does and read the source to learn how to build an Electron app.
Is this a library or a runnable app?It is a standalone desktop application built with Electron itself, not a library you import into your code.
How do I run it?Download the latest prebuilt release for your OS, or build it yourself by installing Node.js and running the start script.
Is this project still maintained?No, the repository is archived, so it no longer receives updates from the core team; community translations may also drift out of sync.
Does it work on Windows, macOS and Linux?Yes, it runs on all three and has packaging scripts for each (darwin, win32, linux targets).
How do I add a new API demo?You extend the app by reading the project docs, which explain how the demo app is structured and how to wire in a new demo panel.
Are there translated versions of the app?Yes, Simplified Chinese, Traditional Chinese, and Japanese translations exist as separate community-maintained forks.
How do I develop and debug it?Run it with the dev script to launch the app in fullscreen with DevTools open for easier development.
Is there automated testing?Yes, the project uses mocha for tests and standard for linting, runnable via the test script.
What are similar projects?awesome-electron, edex-ui, codebase-to-course, Zettlr, docker.kitematic, Bigfish, nativefier, nylas-mail
Which topics is it in?electronjs, examples, electron, beginner-friendly, deprecated, html, desktop, learning, tutorial, gui, education, desktop-app
Creator
electron
Size
5.5 MB
Stars
10.2K
Updated
CommitOct 17Releasev2.0.2Jan 07
Age
11y
Commits · 90 Days