electron-template

An electron, Vue.js and Bootstrap starting point for all!

Clone and run for a quick way to see Electron, Vue.js and Bootstrap in action.

This is a minimal Electron application based on the Quick Start Guide within the Electron documentation.

Use this app along with the Electron API Demos app for API code examples to help you get started.

A basic Electron application needs just these files:

• package.json - Points to the app's main file and lists its details and dependencies.
• main.js - Starts the app and creates a browser window to render HTML. This is the app's main process.
• index.html - A web page to render. This is the app's renderer process.
• renderer.js - Rresponsible for running the user-interface of your app.

You can learn more about each of these components within the Quick Start Guide.

To Use

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/jcramirez/electron-template.git
# Go into the repository
cd electron-template
# Install dependencies
npm install
# Run the app
npm start

Package native apps for Windows, Mac and Linux using electron-packager

To build windows app:

npm run package-win

see package.json for other useful scripts!

Learn more about Electron and its API in the documentation.

Other Example Apps

For more example apps, see the list of boilerplates created by the awesome electron community.

For a basic serial monitor example app see electron-serialmon

License CC0 1.0 (Public Domain)