Scaffold, Run, Test and Package Electron application with ease
Clone or download
Latest commit 86c6b08 Sep 13, 2018
Permalink
Failed to load latest commit information.
bin Change structure: Jun 18, 2016
lib Fix copy command Jul 24, 2018
test Version bump Sep 13, 2018
.editorconfig gulp.src fix for multiple globs Dec 23, 2016
.gitignore First commit Apr 26, 2016
.node-version Update node version May 5, 2018
CONTRIBUTING.md Update CONTRIBUTING.md May 2, 2018
LICENSE Added readme Apr 26, 2016
README.md Update README.md Nov 14, 2017
circle.yml Add caching settings Jul 17, 2018
package.json Version bump Sep 13, 2018
yarn.lock Update packages Sep 13, 2018

README.md

bozon

Scaffold, Run, Test and Package Electron application with ease

npm version img

What is Bozon?

Bozon is a single tool for handling different tasks being performed by multiple packages, which is used for building desktop applications with Electron. Simplify building, compiling, running, testing, and packaging your application.

  • Electron - build cross platform desktop apps with web technologies
  • Gulp - task runner that helps making all important processes with a single command
  • Webpack - building and packaging source code for renderer process done with webpack
  • spectron - Easily test your Electron apps using ChromeDriver and WebdriverIO
  • electron-builder - package and distribute your Electron app

img

Installation

npm install -g bozon

Bozon tool should be installed globally in order to be used for all your electron apps.

Scaffolding

Then generate your new project:

bozon new [name]

This will create a new directory [name] produce the following file structure:

  • Use --skip-install option if you want to skip running npm install
  |--app/
  |  |--images/
  |  |--javascripts/
  |  |  |--renderer/
  |  |  |--main/
  |  |--stylesheets/
  |  |--index.html
  |  |--package.json
  |--config/
  |--spec/
  |--gulpfile.js
  |--package.json

Starting an application

bozon start

This will compile Application source code to ./builds/development directory and run your application from it.

Configuration

Bozon provides a way to define environment specific and platform specific configuration options. These multiple config files are being merged into one single settings object during build. This settings object is being written into package.json file of your application, so that you can use it in your code.

  |--config/
  |  |--settings.json
  |  |--environments/
  |  |  |--development.json
  |  |  |--production.json
  |  |  |--test.json
  |  |--platforms/
  |  |  |--mac.json
  |  |  |--linux.json
  |  |  |--windows.json

Testing

Bozon is using spectron and mocha spec runner for testing Electron applications. Both unit and integration tests should go to ./specs directory. Simply execute for running tests:

bozon test

Packaging application

Packaging Electron application is done by electron-builder using settings in defined in package.json under build section. Application source code is being compiled to ./builds/production/ directory, and packaged versions for different platforms go to ./packages directory.

bozon package [mac|windows|linux]

License

MIT © Alex Chaplinsky