https://github.com/innovation-system/electron-kiosk
Electron KIOSK for web-apps
https://github.com/innovation-system/electron-kiosk
electron kiosk vue vuetify webapp
Last synced: 8 months ago
JSON representation
Electron KIOSK for web-apps
- Host: GitHub
- URL: https://github.com/innovation-system/electron-kiosk
- Owner: innovation-system
- License: mit
- Created: 2022-10-05T09:05:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T16:27:04.000Z (over 1 year ago)
- Last Synced: 2025-02-13T17:31:59.375Z (over 1 year ago)
- Topics: electron, kiosk, vue, vuetify, webapp
- Language: JavaScript
- Homepage:
- Size: 3.02 MB
- Stars: 42
- Watchers: 3
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron KIOSK
Simple Electron app to open a website in fullscreen KIOSK mode.
## Usage
You can download latest release from releases section and choose the right package for your platform.
1. Run the application, main settings windows will open by default with the url to load.
2. Edit settings and on `UPDATE` button, the url will be loaded in fullscreen mode.
Starting from now the application will always load that url on startup and, until the url is not reachable, will show a loader screen.
If you are using a Linux distribution, you can also use the [install.sh](./install.sh) script to download latest release and auto-start the application on startup:
```bash
curl -s https://raw.githubusercontent.com/innovation-system/electron-kiosk/main/install.sh | bash
```
### Shortcuts
| Shortcut | Action |
|----------|--------|
| `Ctrl+Shift+R` | Reload the page |
| `Ctrl+Shift+Q` | Quit the application |
| `Ctrl+Shift+K` | Load settings page |
| `Ctrl+Shift+I` | Open dev tools |
| `Ctrl+Shift+L` | Toggle KIOSK mode |
## Settings
By default all settings are stored in [`app.getPath('userData')`](https://electronjs.org/docs/api/app#appgetpathname):
- Linux: `~/.config/electron-kiosk/config.json`
- Windows: `%APPDATA%/electron-kiosk/config.json`
- MacOS: `~/Library/Application Support/electron-kiosk/config.json`
## Preview
## Development
Developers commands:
```bash
# serve electron app with hot reloading features
npm run dev
# build electron app for production
npm run electron:build
# generate icons for all platforms
npm run icons
# release new version, app boundles will be generated by `release` workflow
npm run release
```
In order to run the application with debug enabled you can use the vscode `Debug All` configuration from "Run and Debug" panel.
## Boilerplate
This project is using [electron-vite-boilerplate](https://github.com/innovation-system/electron-kiosk) as base boilerplate.