An Electron
native client app for cloak
, cloned from electron-react-boilerplate which based on React, Redux, React Router, Webpack, React Transform HMR for rapid application development.
cd cloak-wallet
yarn
Note: If you can't use yarn, run npm install
.
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
# or
npm run dev
Is done using i18next package, the configuration is stored in ./app/i18next.config.js
.
Every string displayed to the user should be wrapped with the translation function. Check i18next documentation for
more details.
Generate locales with the following command:
$ yarn i18n
Locales are poured into the ./locales
directory.
To package apps for the local platform:
yarn package
# or
npm run package
To package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
Then,
yarn package-all
# or
npm run package-all
To package apps with options:
yarn package -- --[option]
# or
npm run package -- --[option]
To run End-to-End Test
yarn build
yarn test-e2e
# or
npm run build
npm run test-e2e
💡 You can debug your production build with devtools by simply setting the DEBUG_PROD
env variable:
DEBUG_PROD=true npm run package
Use the following gist to generate new icons from one 1024x1024 image with transparency: https://gist.github.com/iwuvjhdva/b6329f82a445cc563b143bf014f0c112
To be written.
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.
This boilerplate uses a two package.json structure. This means, you will have two package.json
files.
./package.json
in the root of your project./app/package.json
insideapp
folder
Rule of thumb is: all modules go into ./package.json
except native modules, or modules with native dependencies or peer dependencies. Native modules, or packages with native dependencies should go into ./app/package.json
.
- If the module is native to a platform (like node-postgres), it should be listed under
dependencies
in./app/package.json
- If a module is
import
ed by another module, include it independencies
in./package.json
. See this ESLint rule. Examples of such modules arematerial-ui
,redux-form
, andmoment
. - Otherwise, modules used for building, testing and debugging should be included in
devDependencies
in./package.json
.
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.
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.