Oak

screenshot of Oak

A very opinionated kiosk UI application based on electron

Overview

The Oak module is a transformative tool aimed at simplifying the development of kiosk applications using Electron and modern web technologies. Designed with public computing in mind, such as ATMs and ticket vending machines, Oak removes the unnecessary complexities of traditional desktop applications. Its focus on ease of use and rapid prototyping allows developers to create scalable solutions that cater specifically to the unique needs of kiosk environments.

With Oak, you can quickly launch fullscreen applications that meet the demands of public-facing interfaces while ensuring a smooth and error-free user experience. The module addresses common hurdles associated with Electron applications, streamlining the workflow for developers who need to deploy functional kiosk systems efficiently.

Features

  • Easy Installation: Oak can be installed globally for streamlined access via your system's PATH, enabling efficient deployment.
  • Automatic Module Resolution: The Oak module is automatically resolved on startup, eliminating the need to manually include it in your package.json.
  • Multi-Loading Options: Whether you want to load a full URL, a single HTML file, or configure via a JSON file, Oak provides flexible loading capabilities to accommodate your project's needs.
  • Customizable Window Settings: Developers can customize essential window parameters such as title, display number, fullscreen settings, and more, making it adaptable to various kiosk designs.
  • Kiosk Mode Support: Oak includes a specialized kiosk mode option, ensuring that your application effectively operates in environments where user configuration needs to be limited or controlled.
  • Always-On-Top Feature: The ability to set the application window to be always on top enhances usability in busy public settings, keeping the app front and center for users.