NASA: Pluto Matters!

    daakiya

    0.0.1 • Public • Published


    A boilerplate for Scalable Cross-Platform Desktop Apps based on Electron, React, Redux, React Router, Webpack and React Hot Loader for rapid application development (HMR).





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

    Electron Boilerplate Demo

    Install

    • 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 --single-branch --branch master https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name

    And then install the dependencies with yarn.

    cd your-project-name
    $ yarn

    Run

    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

    Packaging

    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

    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';

    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.

    Dispatching redux actions from main process

    See #118 and #108

    How to keep your project updated with the boilerplate

    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

    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 © Electron React Boilerplate

    Install

    npm i daakiya

    DownloadsWeekly Downloads

    0

    Version

    0.0.1

    License

    MIT

    Unpacked Size

    2.15 MB

    Total Files

    144

    Last publish

    Collaborators

    • sahilanguralla