cra-lerna-electron icon indicating copy to clipboard operation
cra-lerna-electron copied to clipboard

Published 20 hours ago • verified publisher icon amaury1093
→

Metadata

Minimal starter kit: monorepo with ⚛️  Create-React-App + 🐉 Lerna + :electron: Electron

cra-lerna-electron

Minimal starter kit: ⚛️ create-react-app + 🐉 Lerna + :electron: Electron

Getting Started

# Fetch this repo
git clone https://github.com/amaurym/cra-lerna-electron my-app
cd my-app

# Bootstrap the Lerna project, will install all modules
yarn install

Folder structure

The main idea of this starer kit is to separate the Electron and React parts.

.
├── lerna.json                    # Config for Lerna
├── package.json                  # Package.json for the whole repo
├── packages/
│   ├── crale-electron/
│   │   ├── electron-builder.json # Config for electron-build
│   │   ├── electron-webpack.json # Config for electron-webpack
│   │   ├── dist/                 # Binaries bundles by electron-builder
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── main/             # Your electron app goes here
│   │   ├── static/               # Symlinks to ../crale-react/build/ folder
│   ├── crale-react
│   │   ├── build/                # The built app generated by CRA
│   │   ├── package.json
│   │   ├── src/                  # Your react app goes here

Available Commands

All these commands should be run from the project root.

Command Description
yarn start Run Electron and React in dev mode, with live reload on file changes. Allows fast iterations.
yarn build Build Electron and React.
yarn electron Build Electron and React, and open Electron with these built files.
yarn package Build Electron and React, and generate binaries with these built files.
yarn lint Check for linting issues in the code.
yarn test Run tests.

For the exhaustive list of available commands, check package.json.

Tooling

Tool Description
create-react-app All tooling needed for React apps.
lerna Manage JavaScript projects with multiple packages.
electron-webpack Scripts and configurations to compile Electron applications using webpack.
electron-builder A complete solution to package and build a ready for distribution Electron app.

License

MIT.

← Metadata

39
Stars
7
Forks
Watchers

Owner

verified publisher icon amaury1093

Metadata

Minimal starter kit: monorepo with ⚛️  Create-React-App + 🐉 Lerna + :electron: Electron

Back