Electron Template

This repository is a template for an Electron application with a devcontainer setup.

Development Setup

Two notes:

1. You'll need to install and start the XQuartz application. XQuartz simply enables Electron windows.
2. This is a VS Code Remote Containers development project: the development environment is in a container.

Do not fear containerization! Getting this project up and running on your machine can be as simple as pulling down the repository, running the Docker, and clicking twice in VS Code.

Pro-tip: this development configuration is Codespaces compatible in case you're in need of cloud compute!

Prerequisites

• XQuartz
• Docker for Desktop
• Remote Containers (VS Code Extension)

Directions

1. Open XQuartz, which should automatically open an XQuartz-specific Terminal window
   1. If the XQuartz terminal doesn't appear automatically, open the terminal via XQuartz:
      XQuartz > Applications > Terminal
2. Using the XQuartz terminal, allow XQuartz to send/receive data from Docker:
   xhost +localhost
3. Open the repository in VS Code
   code <repo filename>.
4. Select "Remote Containers: Reopen in Container".

The environment will take over and build itself from here; you're good to go! You can close the XQuartz terminal, but the XQuartz application must be running to handle window rendering and events sent from Electron.