# electron-scaffolder

> Electron with Typescript & React starter generator

Latest version **0.0.13** (published 2020-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install electron-scaffolder
pnpm add electron-scaffolder
yarn add electron-scaffolder
bun add electron-scaffolder
```

Provides the command `electron-scaffolder`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.13 |
| Published | 2020-08-31 |
| First published | 2020-08-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 679.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | joegasewicz |
| Maintainers | joegasewicz |
| Keywords | electron, react, typescript, javascript |

## Links

- npm: https://www.npmjs.com/package/electron-scaffolder
- Repository: https://github.com/joegasewicz/sole-trader-desktop
- Homepage: https://github.com/joegasewicz/sole-trader-desktop#readme
- Issues: https://github.com/joegasewicz/sole-trader-desktop/issues
- npm.io page: https://npm.io/package/electron-scaffolder

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.13 (latest) — 2020-08-31
- 0.0.12 — 2020-08-31
- 0.0.11 — 2020-08-31
- 0.0.10 — 2020-08-31
- 0.0.9 — 2020-08-30
- 0.0.8 — 2020-08-29
- 0.0.7 — 2020-08-29
- 0.0.6 — 2020-08-29
- 0.0.5 — 2020-08-29
- 0.0.4 — 2020-08-29
- 0.0.3 — 2020-08-29
- 0.0.2 — 2020-08-29
- 0.0.1 — 2020-08-29

## README

![Electron Scaffolder](./logo.png)

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!

![Electron Scaffolder Libraries](./libs.png)

## 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

---
_Source: https://npm.io/package/electron-scaffolder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._