deb

A desktop electron boilerplate project template.

Clone and run for a quick way to see Electron in action.

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

How to use this project template

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/emergentbit/deb.git YOUR-PROJECT-NAME
# Go into the repository
cd YOUR-PROJECT-NAME
# Setup new repo location for your project
# Make a new repo on Github called YOUR-PROJECT-NAME
git remote set-url origin git@github.com:yourname/YOUR-PROJECT-NAME.git
# Push it
git push
# Install dependencies
yarn install
# Run the app
yarn start

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

Project Structure

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.

Reference Material

TODO - links

Resources for Learning Electron

• electron.atom.io/docs - all of Electron's documentation
• electron.atom.io/community/#boilerplates - sample starter apps created by the community
• electron/electron-quick-start - a very basic starter Electron app
• electron/simple-samples - small applications with ideas for taking them further
• electron/electron-api-demos - an Electron app that teaches you how to use Electron
• hokein/electron-sample-apps - small demo apps for the various Electron APIs