Skip to content

Latest commit

 

History

History
 
 

electron-starter

README.md

Electron Starter Kit

code style: prettier

This is a starter kit of the Electron application development.

Screenshot

Installation

  1. Install Node.js
  2. cd PROJECTDIR
  3. npm install

Development

Watch

Run the watch files, background complie JavaScript/TypeScript/CSS.

npm start

Launch application

Launch the Electron app on electron. Target for the src dir.

npm run app

Unit test

Run the ES6 code of unit tests on mocha with power-assert and espower-typescript.

npm test

Release build

Build the app for production. Please build individually because there is a platform-specific processing.

npm run release:mac
npm run release:win
npm run release:linux

or

npm run release:build
npm run release:pack-mac
npm run release:pack-win
npm run release:pack-linux

It is also will be skipped by running the release:mac or release:pack-mac in the Windows environment.

Package for Windows in macOS

How to build a package for Windows in macOS. Introduction you will install the WineHQ. It is recommended that you use the Homebrew.

brew install --cask wine-stable

Then run the following command. If it is correct environment you should succeed to build the package for Windows.

npm run release:win

or

npm run release

release is a package for all platforms.

ifdef DEBUG

Supports preprocessing with ifdef-loader.

/// #if env == 'DEBUG'
console.log('DEBUG!!!')
/// #endif

This process will be removed in a release version.

License

MIT