Neurotoxin Powered Marketing

    emp-ebooks-reader

    1.7.0 • Public • Published

    electron-react-boilerplate

    A Boilerplate for Scalable Cross-Platform Desktop Apps


    Build Status Appveyor Build Status Dependency Status Github Tag Join the chat at https://gitter.im/electron-react-boilerplate/Lobby OpenCollective OpenCollective

    React Webpack Redux React Router Flow ESLint Jest Yarn

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

    Screenshot

    Electron Boilerplate Demo

    Install

    • Note: requires a node version >= 7 and an npm version >= 4.
    • 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 with yarn.

    cd your-project-name
    $ yarn

    Note: If you can't use yarn for some reason, try npm install.

    Run

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

    $ npm run dev

    Run these two commands simultaneously in different console tabs:

    $ npm run start-renderer-dev
    $ npm run start-main-dev

    Editor Configuration

    Atom

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

    VSCode

    Sublime

    Others

    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 includes the following DevTools extensions:

    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 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:

    @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

    How to add modules to the project

    You will need to add other modules to this boilerplate, depending on the requirements of your project. For example, you may want to add node-postgres to communicate with PostgreSQL database, or material-ui to reuse react UI components.

    ⚠️ Please read the following section before installing any dependencies ⚠️

    Module Structure

    This boilerplate uses a two package.json structure. This means, you will have two package.json files.

    1. ./package.json in the root of your project
    2. ./app/package.json inside app folder

    Which package.json file to use

    Rule of thumb is: all modules go into ./package.json except native modules. Native modules go into ./app/package.json.

    1. If the module is native to a platform (like node-postgres) or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under dependencies in ./app/package.json.
    2. If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule. Examples of such modules are material-ui, redux-form, and moment.
    3. Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

    Further Readings

    See the wiki page, Module Structure — Two package.json Structure to understand what is native module, the rationale behind two package.json structure and more.

    For an example app that uses this boilerplate and packages native dependencies, see erb-sqlite-example.

    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.

    Dispatching redux actions from main process

    see discusses in #118 and #108

    How to keep the boilerplate updated

    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/chentsulin/electron-react-boilerplate.git

    Then, use git to merge some latest commits:

    git pull upstream master

    Maintainers

    Backers

    Support us with a monthly donation and help us continue our activities. [Become a backer]

    Sponsors

    Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

    License

    MIT © C. T. Lin

    Install

    npm i emp-ebooks-reader

    DownloadsWeekly Downloads

    4

    Version

    1.7.0

    License

    MIT

    Last publish

    Collaborators

    • miguelbinpar