template-electron-react

A template project for developing Electron application, using React and TypeScript.

You can create your own project by importing this template project. Once finished, you need to search for "template-electron-react" and replace all of them with your application name.

Build This Application

You're required to use pnpm to manage the npm dependencies, please install the specific version of pnpm (check the packageManager field in package.json).

If you have corepack installed, run corepack enable pnpm then you don't need to care about the pnpm versions.

Run the following command to prepare the environment:

pnpm install

Then you can build this application:

pnpm run build
pnpm run gen-installer

Development

After preparing the environment, run these commands to launch this application in development mode with HMR support:

pnpm run dev

Run these commands to perform the type checking, linting and unit testing:

pnpm run typecheck
pnpm run lint-ci
pnpm run test-ci