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
这是什么?一款桌面应用,通过实时示例代码交互式地演示 Electron 的核心 API,让你看到每个 API 的作用,并阅读源代码以学习如何构建 Electron 应用。
这是库还是可以直接运行的应用?它是一款用 Electron 本身构建的独立桌面应用,而不是可以导入到你代码中的库。
我该如何运行它?下载适用于你操作系统的最新预构建版本,或者安装 Node.js 并运行启动脚本自行构建。
这个项目还在维护吗?不再维护,仓库已归档,核心团队不再提供更新;社区翻译版本也可能与原版不同步。
它能在 Windows、macOS 和 Linux 上运行吗?可以,它支持这三个系统,并为每个系统提供了打包脚本(对应 darwin、win32、linux 目标)。
我该如何添加新的 API 演示?你可以通过阅读项目文档来扩展应用,文档会说明演示应用的结构,以及如何接入新的演示面板。
有没有这个应用的翻译版本?有,存在简体中文、繁体中文和日文的翻译版本,它们都是由社区维护的独立分支。
我该如何开发和调试它?运行 dev 脚本即可全屏启动应用,并打开 DevTools,方便开发。
有自动化测试吗?有,项目使用 mocha 进行测试,使用 standard 进行代码检查,可通过 test 脚本运行。
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