Nand to Tetris new software suite

Electron application boilerplate based on React, Redux, React Router, Webpack, React Transform HMR for rapid application development

Install

Note: requires a node version >= 6 and an npm version >= 3.
If you have installation or compilation issues with this project, please see our debugging guide

First, clone the repo via git:

git clone --depth=1 https://github.com/chentsulin/electron-react-boilerplate.git your-project-name

And then install dependencies. ProTip: Install with yarn for faster and safer installation:

$ cd your-project-name && npm install

Run

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

$ npm run dev

You Run these two commands simultaneously in different console tabs:

$ npm run hot-updates-server
$ npm run start-hot-renderer

Editor Configuration

Atom

apm install editorconfig es6-javascript atom-ternjs javascript-snippets linter linter-eslint language-babel autocomplete-modules file-icons

VSCode

Editorconfig
ESLint
Flow
Babel
Jest
ES6 Snippets
React Snippets 💡 If you are using the flow-for-vscode plugin, make sure to disable the flowtype-errors/show-errors eslint rule in the .eslintrc by setting it to 0

Sublime

Others

Editorconfig
ESLint
Babel Syntax Plugin

DevTools

Toggle Chrome DevTools

OS X: Cmd Alt I or F12
Linux: Ctrl Shift I or F12
Windows: Ctrl Shift I or F12

See electron-debug for more information.

DevTools extension

This boilerplate is included following DevTools extensions:

Devtron - Install via electron-debug.
React Developer Tools - Install via electron-devtools-installer.
Redux DevTools - Install via electron-devtools-installer.

You can find the tabs on Chrome DevTools.

If you want to update extensions version, please set UPGRADE_EXTENSIONS env, just run:

$ UPGRADE_EXTENSIONS=1 npm run dev

# For Windows
$ set UPGRADE_EXTENSIONS=1 && npm run dev

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

DEBUG_PROD=true npm run package

CSS Modules

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

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:

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

Sass support

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

import './app.global.scss';

Packaging

To package apps for the local platform:

$ npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ npm run package-all

To package apps with options:

$ npm run package -- --[option]

Further commands

To run the application without packaging run

$ npm run build
$ npm start

To run End-to-End Test

$ npm run build
$ npm run test-e2e

Options

See electron-builder CLI Usage

Module Structure

This boilerplate uses a two package.json structure. For an example app that uses this boilerplate and packages native dependencies, see erb-sqlite-example.

If the module is native to a platform or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under dependencies in ./app/package.json.
If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule.
Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

Static Type Checking

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.

Native-like UI

If you want to have native-like User Interface (OS X El Capitan and Windows 10), react-desktop may perfect suit for you.

dreisel/NandToTetrisElectron