Electron Scaffolder is a CLI that generates an Electron starter application & scaffolds a project with Typescript, ReactJS & WebpackJS with enough configuration to get you started on your next exciting Electron project!

Getting started

Install

npm install -g electron-scaffolder

Create & Run Your Project

electron-scaffolder my_project
cd my_project
npm install
npm run start

Electron Scaffolder will generate your project for you with the below file structure tree:

├── README.md
├── index.html
├── main.js
├── package-lock.json
├── package.json
├── src
│   ├── index.tsx
│   ├── sass
│   │   └── index.scss
│   └── views
│       ├── index.ts
│       ├── main.styles.tsx
│       └── main.tsx
├── tsconfig.json
└── webpack.config.js

List all commands

electron-scaffolder --help

Create the project in current directory

electron-scaffolder <your_project> --flat

The --flat argument will create a the project in the current directory