Skip to content

README.md

Latest commit

 

History

History
53 lines (32 loc) · 1.13 KB

README.md

File metadata and controls

53 lines (32 loc) · 1.13 KB
Raw

Electron, TypeScript, React Boilerplate

Lightweight, modern boilerplate built with electron, typescript, and react.

Major technologies

Developer Experience

  • TypeScript
  • ESLint
  • Prettier

Requires

  • Node.js 14
  • NPM 7

Getting Started

  1. Download or clone the repo
git clone https://github.com/hellosoftware-io/electron-typescript-react myapp
  1. Navigate to the project directory in your command line
cd myapp
  1. Run npm install to install dependencies
  2. Run npm run dev to build and run the site locally

About

This project is meant to be as lightweight as possible to help developers get started with electron and react as quickly as possible.

Because a new version of electron is used, Babel is not used for transpiling. Plain TypeScript is used instead.

Live reloading is included thanks to webpack 5 and webpack-dev-server.

Contributing

Pull requests are always welcome 😃.

License

This project is licensed under the terms of the MIT license.