https://github.com/gy-toxyc/electron_template

Useful template to base your new Electron project. Includes BabelJS and TypeScript installations.
https://github.com/gy-toxyc/electron_template

babeljs desktop-app electron javascript nodejs template typescript

Last synced: 8 months ago
JSON representation

Useful template to base your new Electron project. Includes BabelJS and TypeScript installations.

• Host: GitHub
• URL: https://github.com/gy-toxyc/electron_template
• Owner: gy-toxyc
• Created: 2022-09-28T15:00:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-31T17:56:50.000Z (over 3 years ago)
• Last Synced: 2025-02-02T00:24:34.181Z (over 1 year ago)
• Topics: babeljs, desktop-app, electron, javascript, nodejs, template, typescript
• Language: JavaScript
• Homepage:
• Size: 28.3 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Electron Project Template




This Electron template is a simple directory in which you can base your new desktop application project easily.



***



> How to use



- The folder **"docs"** works as a tutorial here for every basic action you'll take installing and packaging your electron project into a desktop application.

- Firstly, read carefully the **"GET_STARTED.md"** file, it'll teach you how to install Electron and NodeJS modules. Just after installing those, you'll have optional instalations such as BabelJS (recommended for ES6 modules) and TypeScript. It will also put your project inside Electron Forge so you can test it while coding.

- You must aknowledge that the directories **"node_modules"** and **"electron_base"** are mandatory for the project to work properly. You can delete **"docs"** once your project is already set up, as it's just a tutorial. Also, it may be cleared before or after, but this template works as a tutorial to set up your Electron project, but not as a tutorial of how Electron and NodeJS works, if you need information about those technologies, all documentations of each one will be provided at the end of this document.

- Secondly, in order to try your code, read the **"PACKING.md"** file, but just take the first 2 commands yet, as the last one will be the last part of your development process.

- And in the end, by now, you can execute the last command on **"PACKING.md"** to pack your project into a distributable desktop application.




***

Sadly, this template does not cover updates handling yet, as I'm still learning about it, to be honest. But I recomment you actively to visit Electron docs which covers this concept.


Electron Documentation


NodeJS Documentation


BabelJS Documentation


TypeScript Documentation