Skip to content

An Electron project template for creating desktop apps.

License

Notifications You must be signed in to change notification settings

mogrifier/electron-template

Repository files navigation

Electron Project Template

This is an Electron project template. You can clone and use under the MIT license. There is a tiny bit of code just to show some simple working concepts you need in Electron applications. Details here: https://eizdepski.medium.com/electron-desktop-app-template-14c5e9c40b1e The template helps with:

  • electron project structure
  • using npm to run commands
  • unit testing
  • code coverage
  • lint checks
  • building deployment artifacts
  • publishing your app

You will have to ensure you install the Node JS Modules needed to run this. Also, the package.json file "publishers" under forge config is set to publish to MY repo. That will not work for you, so change it and set up your access token to allow publishing the project releases to YOUR repo. There are several other changes to make to package.json to make things point to your repo, your project name, links to your project, new keywords, etc. Other commands you need to get going are below.

Install commands needed

  • npm install - save-dev @electron-forge/cli
  • npx electron-forge import
  • npm i -g @electron-forge/maker-zip
  • npm i -g @electron-forge/publisher-github
  • npm i -g eslint

Note the '-g' flag means install globally, so that all future projects can use these modules and associated commands without needed to re-install the modules.

Life-cycle commands

  • npm run make
  • npm run start
  • npm test
  • npm run lint
  • npm run publish

I am using code from this repo https://github.com/reZach/secure-electron-template to establish secure IPC communications, rather than exposing everything in node from your renderer process.

Thanks!

About

An Electron project template for creating desktop apps.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published