# electron-react-mobx-boilerplate **Repository Path**: moxun.net/electron-react-mobx-boilerplate ## Basic Information - **Project Name**: electron-react-mobx-boilerplate - **Description**: No description available - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2018-05-18 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # erb-mobx-antd 基于 [electron-react-boilerplate](https://github.com/chentsulin/electron-react-boilerplate)的 electron+react+mobx 脚手架, 1、支持 LESS 样式 2、合并 renderer 的 rules # electron-react-boilerplate ### A Boilerplate for Scalable Cross-Platform Desktop Apps
## 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](https://github.com/chentsulin/electron-react-boilerplate/issues/400)** First, clone the repo via git: ```bash git clone --depth=1 https://github.com/moxun33/erb-mobx-antd.git your-project-name ``` And then install dependencies with yarn. ```bash $ cd your-project-name $ yarn ``` **Note**: If you can't use [yarn](https://github.com/yarnpkg/yarn), run `npm install`. ## Run Start the app in the `dev` environment. This starts the renderer process in [**hot-module-replacement**](https://webpack.js.org/guides/hmr-react/) mode and starts a webpack dev server that sends hot updates to the renderer process: ```bash $ npm run dev ``` Alternatively, you can run the renderer and main processes separately. This way, you can restart one process without waiting for the other. Run these two commands **simultaneously** in different console tabs: ```bash $ npm run start-renderer-dev $ npm run start-main-dev ``` ## Packaging To package apps for the local platform: ```bash $ npm run package ``` To package apps for all platforms: First, refer to [Multi Platform Build](https://www.electron.build/multi-platform-build) for dependencies. Then, ```bash $ npm run package-all ``` To package apps with options: ```bash $ npm run package -- --[option] ``` To run End-to-End Test ```bash $ npm run build $ npm run test-e2e ``` :bulb: You can debug your production build with devtools by simply setting the `DEBUG_PROD` env variable: ```bash DEBUG_PROD=true npm run package ``` ## 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](https://github.com/brianc/node-postgres) to communicate with PostgreSQL database, or [material-ui](http://www.material-ui.com/) to reuse react UI components. ⚠️ Please read the following section before installing any dependencies ⚠️ ### Module Structure This boilerplate uses a [two package.json structure](https://github.com/electron-userland/electron-builder/wiki/Two-package.json-Structure). This means, you will have two `package.json` files. 1. `./package.json` in the root of your project 1. `./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 `import`ed by another module, include it in `dependencies` in `./package.json`. See [this ESLint rule](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md). 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](https://github.com/chentsulin/electron-react-boilerplate/wiki/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](https://github.com/amilajack/erb-sqlite-example). ## CSS Modules This boilerplate is configured to use [css-modules](https://github.com/css-modules/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`: ```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: ```js 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](https://github.com/amilajack/eslint-plugin-flowtype-errors), and get [type errors during runtime](https://github.com/codemix/flow-runtime) during development. Types are completely optional. ## Dispatching redux actions from main process See [#118](https://github.com/chentsulin/electron-react-boilerplate/issues/118) and [#108](https://github.com/chentsulin/electron-react-boilerplate/issues/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: ```sh git remote add upstream https://github.com/chentsulin/electron-react-boilerplate.git ``` Then, use git to merge some latest commits: ```sh git pull upstream master ``` ## Maintainers - [C. T. Lin](https://github.com/chentsulin) - [Jhen-Jie Hong](https://github.com/jhen0409) - [Amila Welihinda](https://github.com/amilajack) ## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/electron-react-boilerplate#backer)]

## Sponsors Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/electron-react-boilerplate#sponsor)]

## License MIT © [C. T. Lin](https://github.com/chentsulin) [npm-image]: https://img.shields.io/npm/v/electron-react-boilerplate.svg?style=flat-square [github-tag-image]: https://img.shields.io/github/tag/chentsulin/electron-react-boilerplate.svg [github-tag-url]: https://github.com/chentsulin/electron-react-boilerplate/releases/latest [travis-image]: https://travis-ci.org/chentsulin/electron-react-boilerplate.svg?branch=master [travis-url]: https://travis-ci.org/chentsulin/electron-react-boilerplate [appveyor-image]: https://ci.appveyor.com/api/projects/status/github/chentsulin/electron-react-boilerplate?svg=true [appveyor-url]: https://ci.appveyor.com/project/chentsulin/electron-react-boilerplate/branch/master [david_img]: https://img.shields.io/david/chentsulin/electron-react-boilerplate.svg [david_site]: https://david-dm.org/chentsulin/electron-react-boilerplate