Skip to content

SanjaySunil/create-electron-app

Repository files navigation

Logo

create-electron-app

Generate a new Electron App within a minute!

Report Bug · Request Feature · Support




What's create-electron-app?

Create-Electron-App is a simple, minimal CLI app that can generate an Electron App within a minute! Create-Electron-App uses Electron-Boilerplate as the boilerplate.

✨ Features

  • Fast Installation: Simply run npx new-electron-app!
  • 🔨 Electron-Builder: Electron Builder implementation ready for cross-platform builds.
  • Customisation: Easy to customise and built-in features.

🛠 Getting Started

Step 1: Prerequisites

  • npm
npm install npm@latest -g
  • new-electron-app
npm install new-electron-app -g

Step 2: Installation

  1. Open your preferred terminal.

  2. Run new-electron-app anywhere!

npx new-electron-app

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Copyright © 2021 Sanjay Sunil (sanjaysunil@protonmail.com)

Distributed under the MIT License. See LICENSE for more information.