https://github.com/sanjaysunil/create-electron-app

Generate a new Electron App within a minute!
https://github.com/sanjaysunil/create-electron-app

boilerplate create-electron-app electron electron-app-builder electron-boilerplate electron-npm electron-template npm

Last synced: 2 months ago
JSON representation

Generate a new Electron App within a minute!

• Host: GitHub
• URL: https://github.com/sanjaysunil/create-electron-app
• Owner: SanjaySunil
• License: mit
• Created: 2021-01-01T10:48:00.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-15T10:57:58.000Z (over 1 year ago)
• Last Synced: 2024-09-19T09:42:13.928Z (4 months ago)
• Topics: boilerplate, create-electron-app, electron, electron-app-builder, electron-boilerplate, electron-npm, electron-template, npm
• Language: JavaScript
• Homepage: https://sanjaysunil.github.io/create-electron-app
• Size: 504 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        



  

    

  



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

```sh

npm install npm@latest -g

```

- new-electron-app

```sh

npm install new-electron-app -g

```




### **Step 2:** Installation

1. Open your preferred terminal.

2. Run new-electron-app anywhere!

```sh

npx new-electron-app

```




## Roadmap

See the [open issues](https://github.com/SanjaySunil/create-electron-app/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 ([email protected])

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