/electron-boilerplate

Electron boilerplate (Electron + Babel + React + Webpack)

Primary LanguageJavaScriptCreative Commons Zero v1.0 UniversalCC0-1.0

Electronยฎ Boilerplate

This Electron boilerplate uses Babel to uses all ES6/ES7 features, Webpack to automatically reload changes while developing an electron app adn React+Mobx to build the application interface.

Download and install

npm install
# Runs webpack on watch mode
npm run start-dev
# Starts the Electron app
npm run start

Folder structure ๐Ÿ“

โ”œโ”€โ”€ electron-boilerplate/
    |
    โ”œโ”€โ”€ app/
    |   โ”œโ”€โ”€ js/
    |   |   โ”œโ”€โ”€ components/
    |   |   โ”œโ”€โ”€ config/
    |   |   โ”œโ”€โ”€ internationalization/
    |   |   โ”œโ”€โ”€ models/
    |   |   โ”œโ”€โ”€ views/
    |   |   โ”œโ”€โ”€ routes/
    |   |   โ”œโ”€โ”€ stores/
    |   |   โ””โ”€โ”€ utils/
    |   |
    |   |
    |   โ”œโ”€โ”€ scss/
    |   |   โ”œโ”€โ”€ components/
    |   |   โ”œโ”€โ”€ containers/
    |   |   โ”œโ”€โ”€ mixins/
    |   |   โ”œโ”€โ”€ settings/
    |   |   โ”œโ”€โ”€ ux/
    |   |   โ””โ”€โ”€ main.scss
    |   |
    |   |
    |   โ””โ”€โ”€ app.js <-- Electron render
    |
    |
    โ”œโ”€โ”€ public/ <-- Public files goes here
    |   โ”œโ”€โ”€ css/
    |   โ”œโ”€โ”€ font/
    |   โ”œโ”€โ”€ img/
    |   โ”œโ”€โ”€ js/
    |   โ”œโ”€โ”€ lib/
    |   โ”œโ”€โ”€ locales/
    |   โ”œโ”€โ”€ video/
    |   โ”œโ”€โ”€ workers/
    |   |   
    |   โ””โ”€โ”€ index.html
    |
    |
    โ”œโ”€โ”€ .eslintrc
    โ”œโ”€โ”€ .gitignore
    โ”œโ”€โ”€ deploy.sh
    โ”œโ”€โ”€ LICENSE.md
    โ”œโ”€โ”€ main.js  <-- Electron entry point
    โ”œโ”€โ”€ package.json
    โ”œโ”€โ”€ README.md
    โ””โ”€โ”€ webpack.config.js