https://github.com/tristanbettany/electrontemplate
A Template To Build Electron Apps Quickly
https://github.com/tristanbettany/electrontemplate
electron electron-template javascript nodejs
Last synced: about 1 month ago
JSON representation
A Template To Build Electron Apps Quickly
- Host: GitHub
- URL: https://github.com/tristanbettany/electrontemplate
- Owner: tristanbettany
- License: mit
- Created: 2023-11-17T07:40:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-17T07:45:57.000Z (over 1 year ago)
- Last Synced: 2025-02-01T01:35:09.601Z (3 months ago)
- Topics: electron, electron-template, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 237 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron Template
This template is designed to be a quick start to building an application that as default runs
with a hidden window and a tray icon and context menu which you can open additional windows from
like a settings window.
## Usage
To use simply clone the repo and do the following
```
npm install
npm run build
npm run start
```
This will install dependancies, then build the PostCSS, then start the application. You can find
the tray icon in your system tray and right clicking will give you the context menu to open the
settings.
## Packaging
If you want to package to an installer for distribution simply do the following
```
npm run package
```
The packaging tool used is squirrel js, so for further information in controling that look at their docs.