gikkman / electron-typescript-opinionated-started

electron-typescript-opinionated-started

This opinionated starter is intended to help with quickly getting an Electron app up, with a simple build process, and which can be debugged in VSCode using the native debugger (with breakpoints and everything).

• To install this starter, clone the repository, then run npm i. This will install the dependecies, and build the native dependencies.
  • After having cloned the repository, open the package.json file and edit the field build.** settings. Please see the documentation.
• To run this starter, either start it via the debugger in VSCode, or run npm start
• To build an artifact from this starter, run npm run release-this

This started comes with a bundled SQLite database. There is a migrations system in place.

• To create a new database migration, run npm run new-migration migration-name-here
• Migrations will occur on startup of the app

Notes

Bellow is a list of additional tools you might consider adding to your app.

• Electron Util - A handy collection of "nice to have" features:
  • https://github.com/sindresorhus/electron-util
• Typescript-Formatter - A code formatter for Typescript
  • https://github.com/vvakame/typescript-formatter
• Google Typescript Formatter - As above, but google's verions
  • https://github.com/google/gts