obiwanjacobi / electron-react-ts

Boilerplate quick start tutorial project for Electron + React in TypeScript with Visual Studio Code.

electron-react-ts

This example is based on the Electron application quick start tutorial Quick Start Guide.

The project contains these files (among others):

• package.json - Points to the app's entry point and lists its details and dependencies.
• tsconfig.json - Configurures the TypeScript compiler.
• Program.ts - Starts the app and creates a browser window to render HTML. This is the app's main process.
• index.html - The main (web) page to render. This is the app's renderer process.
• Application.tsx - The React component that is attached to index.html.
• Application.css - Styles loaded into index.html.

Visual Studio Code

• launch.json - Contains launch and debug parameters for the F5 experience for both the main process (Program) as well as the render process (Application).
• tasks.json - Contains the default compile/build task (Ctrl+Shift+B).

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/obiwanjacobi/electron-react-ts
# Go into the repository
cd electron-react-ts
# Install dependencies
npm install
# Run the app
npm start

Conventions

• Names starting with an upper case Letter are types.
• Names starting with a lower case letter are vars or members.

License

CC0 1.0 (Public Domain)

Created december 2017.