TheTastefulToastie / electron-boilerplate

A minimal Electron boilerplate application based on the Quick Start Guide.

Electron Boilerplate

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

Usage

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/TheTastefulToastie/electron-boilerplate

# Go into the repository
cd ElectronBoilerplate

# Install dependencies
yarn

# Run the app
yarn dev

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Available Scripts

# Run the bundler and finish, without starting electron
yarn build

# Host your application with hot-module-reload at `http://localhost:1234` without starting electron
yarn serve

# Run the bundler once, then start electron
yarn start

# Run your electron application with hot-module-reload
yarn dev

License

MIT License