メインコンテンツへ飛ぶ

Electron とは何ですか?

Electron は、JavaScript、HTML、CSS によるデスクトップアプリケーションを構築するフレームワークです。 Electron は ChromiumNode.js をバイナリに組み込むことで、単一の JavaScript コードベースを維持しつつ、ネイテイブ開発経験無しでも Windows、macOS、Linux で動作するクロスプラットフォームアプリを作成できます。

はじめましょう

まずは チュートリアル から始めて、Electron アプリの開発からユーザーへの頒布までの流れを把握することを推奨します。 サンプルAPI ドキュメント もブラウズして新しいものを発見するには良い場所でしょう。

Electron Fiddle でサンプルを動かす

Electron Fiddle は Electron で書かれたサンドボックスアプリで、Electron のメンテナがサポートしています。 Electron の API を試したり開発中の機能を試作するための学習ツールとして、インストールを強く推奨します。

また、Fiddle はドキュメントとうまく統合してあります。 チュートリアルのサンプルを見ていると、コードブロックの下に "Electron Fiddle で開く" ボタンが表示されていることがよくあります。 Fiddle がインストールされている場合、このボタンを押すと fiddle.electronjs.org のリンクが開き、コピーペーストせずとも自動的に Fiddle にサンプルがロードされます。 fiddle docs/latest/fiddles/quick-start

ドキュメントには何が入っているのでしょうか?

すべての公式ドキュメントは、サイドバーから閲覧できます。 以下にてそれぞれのカテゴリーと、そこに書かれているであろうことについてご紹介します。

  • チュートリアル: 初めての Electron アプリケーションを作成してから公開するまでのやり方を一貫して示したガイドです。
  • Electron 内のプロセス: Electron のプロセスに関する詳細なリファレンスとその使用方法。
  • ベストプラクティス: Electron アプリの開発で押さえておきたい重要なチェックリスト。
  • Examples: Quick references to add features to your Electron app.
  • 開発: その他の開発ガイド。
  • 頒布: エンドユーザにアプリを頒布する方法を学びましょう。
  • テストとデバッグ: JavaScript のデバッグ方法やテストの書き方など、高品質な Electron アプリケーション作成に使用するツールをご紹介します。
  • References: Useful links to better understand how the Electron project works and is organized.
  • Contributing: Compiling Electron and making contributions can be daunting. この章に従えばより簡単に貢献できるようにしてあります。

ヘルプチャンネル

どこかで行き詰まってしまいましたか? こちらに、ご覧いただきたいリンクがいくつかあります。

  • アプリ開発で助けを求めたい場合、コミュニティ Discord サーバー で他の Electron アプリ開発者からアドバイスを受けることができます。
  • electron パッケージのバグが疑われる場合は、GitHub Issue トラッカー で既存の Issue とあなたの Issue に合致するものがないかご確認ください。 もし無ければ、バグレポートのテンプレートに記入し、新しい Issue をご提出ください。