Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ddmitov/perl-executing-browser
HTML interface for Perl 5 desktop applications :dromedary_camel:
https://github.com/ddmitov/perl-executing-browser
appimages desktop-application-sdk electron-alternative gui html perl5 qt5 qtwebkit
Last synced: about 2 months ago
JSON representation
HTML interface for Perl 5 desktop applications :dromedary_camel:
- Host: GitHub
- URL: https://github.com/ddmitov/perl-executing-browser
- Owner: ddmitov
- License: other
- Created: 2013-11-29T01:47:07.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T18:09:11.000Z (12 months ago)
- Last Synced: 2024-04-18T03:39:26.734Z (5 months ago)
- Topics: appimages, desktop-application-sdk, electron-alternative, gui, html, perl5, qt5, qtwebkit
- Language: C++
- Homepage:
- Size: 12.9 MB
- Stars: 64
- Watchers: 9
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-electron-alternatives - Perl Executing Browser
README
# Perl Executing Browser
[](https://github.com/ddmitov/perl-executing-browser/releases)
[](./LICENSE.md)
Perl Executing Browser (PEB) is an HTML user interface for [Perl 5](https://www.perl.org/) desktop applications. It is a C++ [Qt 5](https://www.qt.io/) application running local Perl scripts as child processes without server. Inspired by [Electron](http://electron.atom.io/) and [NW.js](http://nwjs.io/), PEB is another reuse of web technologies in desktop applications with Perl doing the heavy lifting instead of [Node.js](https://nodejs.org/en/).
## Contents
* [Quick Start](#quick-start)
* [Design Objectives](#design-objectives)
* [Features](#features)
* [Security](#security)
* [Limitations](#limitations)
* REQUIREMENTS
* [Compile-Time Requirements](./doc/REQUIREMENTS.md#compile-time-requirements)
* [Runtime Requirements](./doc/REQUIREMENTS.md#runtime-requirements)
* FILES AND FOLDERS
* [Application Executable](./doc/FILES.md#application-executable)
* [Application Files and Folders](./doc/FILES.md#application-files-and-folders)
* SETTINGS
* [Global Settings API](./doc/SETTINGS.md#global-settings-api)
* [Perl Scripts API](./doc/SETTINGS.md#perl-scripts-api)
* [Files and Folders Dialogs API](./doc/SETTINGS.md#files-and-folders-dialogs-api)
* APPIMAGE SUPPORT
* [PEB AppImager](./doc/APPIMAGE.md#peb-appimager)
* [PEB AppImage Configuration Files](./doc/APPIMAGE.md#peb-appimage-configuration-files)
* [AppImageHub](./doc/APPIMAGE.md#appimagehub)
* [Logging](#logging)
* [History](#history)
* [Thanks and Credits](./CREDITS.md)
* [License](./LICENSE.md)
* [Authors](#authors)
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" and "OPTIONAL"
in the documentation of this project are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
## Quick Start
* **1.** [Download the PEB Demo Application](https://github.com/ddmitov/perl-executing-browser/releases/latest).
64-bit Linux single-file [AppImage](https://appimage.org/) executable and
32-bit Windows ZIP archive are available.
They include everything you need to start developing PEB-based applications.
* **2.** Unpack:
64-bit Linux:
```bash
./peb-demo-*.AppImage --appimage-extract
```
Windows:
Unzip using any Windows unzip utility.
* **3.** Optionally install any CPAN modules you may need:
64-bit Linux:
```bash
cd squashfs-root/resources/app/perl/bin
./perl ./cpanm YourModule
```
Windows - from the extracted ``peb-demo`` directory:
```batchfile
cd resources\app\perl
.\portableshell.bat
cpanm YourModule
```
* **4.** Write your Perl application reading user input on STDIN:
```perl
my $input = ;
chomp $input;
```
* **5.** Write a ``{PEB_executable_directory}/resources/app/index.html`` with
a [settings JavaScript object](./doc/SETTINGS.md#perl-scripts-api) for every Perl script you want to use.
Start local Perl scripts by [clicking a link or submitting a form to a special URL](./doc/SETTINGS.md#perl-scripts-api).
[Select files or folders with their full paths by clicking a link to a special URL](./doc/SETTINGS.md#selecting-files-and-folders).
* **6.** Optionally change the [PEB AppImage configuration files](./doc/APPIMAGE.md#peb-appimage-configuration-files).
* **7.** Optionally pack your application:
64-bit Linux - from the extracted ``squashfs-root`` directory:
```bash
export VERSION="X.X.X" && ./appimager.sh
```
The resulting AppImage will be produced in the ``squashfs-root`` directory.
Windows:
Zip your PEB-based application using any Windows zip utility.
## Design Objectives
* **1. Easy graphical user interface for Perl 5 desktop applications**
* **2. Zero-installation software**
* **3. Cross-platform availability**
* **4. Secure solution with no server process**
* **5. Maximal reuse of existing web technologies and standards**
## Features
* [PEB can be started from any folder without installation procedure.](./doc/CONSTANTS.md#files-and-folders)
* No limitation on how long a Perl script can run.
* [Perl script output is seamlessly inserted in an HTML user interface.](./doc/SETTINGS.md#perl-scripts-api)
* [Any version of Perl 5 can be used.](./doc/REQUIREMENTS.md#runtime-requirements)
* [Select files and folders.](./doc/SETTINGS.md#selecting-files-and-folders)
* [Logging of Perl errors in the JavaScript console](#logging)
* [Optional warning for unsaved data in HTML forms](./doc/SETTINGS.md#html-page-api)
* [Optional labels for the JavaScript popup boxes and context menus](./doc/SETTINGS.md#html-page-api)
* [Optional icon](./doc/FILES.md#icon)
## Security
* PEB does not need administrative privileges or installation procedure.
* PEB does not need and does not implement any server process.
* PEB can not open web pages.
* PEB Perl scripts are executed locally with no sandbox.
## Limitations
* No access to web pages
* No Perl scripting inside frames
* No pop-up windows
* No printing
* Limited HTML5 support
## Logging
PEB has unified logging of JavaScript and Perl errors in the JavaScript console.
Press Ctrl + I to open the ``QWebInspector`` and go to the ``Console`` tab.
## History
PEB was started in 2013 by Dimitar D. Mitov as a simple user interface for personal database applications.
## [Thanks and Credits](CREDITS.md)
## [License](./LICENSE.md)
This program is free software;
you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License,
as published by the Free Software Foundation;
either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
## Authors
Dimitar D. Mitov, 2013 - 2020, 2023
Valcho Nedelchev, 2014 - 2016