https://github.com/krsbx/create-roses-electron

Simplify process of creating an Electron Desktop App with TypeScript, Vite, and React
https://github.com/krsbx/create-roses-electron

Last synced: 11 days ago
JSON representation

Simplify process of creating an Electron Desktop App with TypeScript, Vite, and React

• Host: GitHub
• URL: https://github.com/krsbx/create-roses-electron
• Owner: krsbx
• Created: 2022-09-13T11:31:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-01T04:00:31.000Z (over 1 year ago)
• Last Synced: 2024-11-13T00:43:28.460Z (2 months ago)
• Language: TypeScript
• Size: 803 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        


  create-roses-electron





  Interactive CLI to quickly set up an Electron projects with React and Vite.





  Get started with CRE by running npx create-roses-electron





[![PRs-Welcome][contribute-image]][contribute-url] [![NPM version][npm-image]][npm-url]

[![Downloads][downloads-image]][npm-url]



[downloads-image]: https://img.shields.io/npm/dm/create-roses-electron?color=364fc7&logoColor=364fc7

[npm-url]: https://www.npmjs.com/package/create-roses-electron

[npm-image]: https://img.shields.io/npm/v/create-roses-electron?color=0b7285&logoColor=0b7285

[contribute-url]: https://github.com/krsbx/create-roses-electron/blob/main/CONTRIBUTING.md

[contribute-image]: https://img.shields.io/badge/PRs-welcome-blue.svg

## Table of contents

- What is CRE?

- Getting Started

- CLI Docs

- Contributors

What is CRE?


"_Create Roses Electron_" is a CLI that you can run to initialize your Electron App much faster by including all the necessary tools, React and etc, that you need by using one of the fastest tool to rebuild your code, Vite.

**Keep in mind** that the generated template/boilerplate can still be modified as much as you like.

Getting Started


To get started with `create-roses-electron`, run any of the following commands and answer any questions from the prompt:

### npm

```bash

npx create-roses-electron@latest

```

CLI Docs


The following CLI options and flags can be use to configure the behavior when running the CLI:

| Option/Flag       | Description                                           |

| ----------------- | ----------------------------------------------------- |

| `[dir]`           | The directory to create the new Roses Electron        |

| `--noGit`         | Explicitly tell to not init a git repository          |

| `--noInstall`     | Explicitly tell to not install all dependencies       |

| `-y`, `--default` | Bypass the CLI and use default values for all prompts |

Contributors


We 💖 contributors! Feel free to contribute to this project but **please read the [Contributing Guidelines](CONTRIBUTING.md) before opening an issue or PR** so you understand the branching strategy and local development environment.