An Audio/Visual projection tool for churches and concerts. It is a Scalable Cross-Platform Desktop App based on Electron, React, Mobx, React Router, Webpack and React Hot Loader and setup for rapid application development (HMR).

This project was spawned off https://github.com/electron-react-boilerplate/electron-react-boilerplate.git.

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a webpack dev server that sends hot updates to the renderer process:

$ yarn dev

If you don't need autofocus when your files was changed, then run dev with env START_MINIMIZED=true:

$ START_MINIMIZED=true yarn dev

To package apps for the local platform:

$ yarn package

To package apps for all platforms:

First, refer to the Multi Platform Build docs for dependencies.

Then,

$ yarn package-all

To package apps with options:

$ yarn package --[option]

To run End-to-End Test

$ yarn build-e2e
$ yarn test-e2e

# Running e2e tests in a minimized window
$ START_MINIMIZED=true yarn build-e2e
$ yarn test-e2e

💡 You can debug your production build with devtools by simply setting the DEBUG_PROD env variable:

DEBUG_PROD=true yarn package

From OSX, you can package for all 2 platforms i.e Windows, OSx and Linux. Sometimes you might get some errors due to system dependencies you haven't installed yet.

If you see the error:

{:timestamp=>"xxx", :message=>"Need executable 'rpmbuild' to convert dir to rpm", :level=>:error}

Install the system package rpm. i.e brew install rpm on OSX or sudo apt-get install rpm on Ubuntu, etc.

This boilerplate is configured to use css-modules out of the box.

All .css file extensions will use css-modules unless it has .global.css.

If you need global styles, stylesheets with .global.css will not go through the css-modules loader. e.g. app.global.css

If you want to import global css libraries (like bootstrap), you can just write the following code in .global.css like so:

@import '~bootstrap/dist/css/bootstrap.css';

If you want to use Sass in your app, you only need to import .sass files instead of .css once:

import './app.global.scss';

This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.

See #118 and #108

If your application is a fork from this repo, you can add this repo to another git remote:

git remote add upstream https://github.com/electron-react-boilerplate/electron-react-boilerplate.git

Then, use git to merge some latest commits:

git pull upstream master

• Iyobo Eki

GPL © EpicWorship