Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.12 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.12 KB

electron-demo-app

Workflow status

This is a demonstration of an Electron desktop app with basic CI/CD and cross-platform functionality.

Our goals with this app are to learn how to:

  • structure a basic Electron app
  • use TypeScript
  • build installers for Linux, Mac, and Windows
  • automated testing
  • use the CI/CD functionality (workflows) of GitHub with an Electron app

Usage

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

$ git clone https://github.com/sep/electron-demo-app
$ cd electron-demo-app
$ npm install
$ npm start

Other commands

  • compile - transpile TypeScript into JavaScript
  • start - launch the Electron app
  • lint - run ESLint
  • test - run automated UNIT tests
  • test-- - run automated INTEGRATION tests with the specified tool and platform
  • package - bundle the Electron app to get it ready for distribution
  • make-* - make installer for the specified platform(s)