aabuhijleh / browser-window-renderer-proxy

Electron TypeScript Quick Start

This template is based on the official electron-quick-start repository (but with typescript + electron-builder)

Note: checkout prettier branch for a project with prettier/tslint integration + git hooks for enforcing consistent styling

How to use?

# install dependencies
$ npm install

# compile typescript files
$ npm run compile

# watch typescript files for changes (auto compilation)
$ npm run watch

# run the app
$ npm start

# create distributable packages for specific platforms
$ npm run dist-linux
$ npm run dist-mac
$ npm run dist-windows

Directory Structure

.
├── electron-builder.json (electron-builder configuration)
├── .gitignore
├── LICENSE.md
├── package.json
├── package-lock.json
├── README.md
├── src (typescript files go here)
│   ├── main.ts
│   ├── preload.ts
│   └── renderer.ts
├── tsconfig.json (typescript compiler options)
├── tslint.json (tslint configuration)
└── views (html, css files go here)
    └── index.html

Resources

• Electron docs
• electron-builder docs
• Typescript docs
• Tslint docs