Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Introduction

Leonardo Laureti edited this page Jul 23, 2019 · 3 revisions

Introduction

The primary intent was to allow simple data manipulation without have to install web servers, tons of software and deps, create a portable app quickly with the possibility to write spaghetti code, fairly simple to use, executable almost anywhere, with essential features and small footprint.

 

Folder structure

The folder structure is simplified to facilitate the user, there is a launcher file to open "LAUNCH.html", all the runtime content is inside the folder "app", save files are contained in the folder "save", extensions in the folder "ext", the alternate execution in the folder "alt". In the release phase you could delete superfluous files and folders like "docs" and "src".

 

How it works

The source JavaScript is located in "src/appe/src", it is divided into sections to simplify understanding, the name of sections is intuitive.

The index file "index.html" contained in the runtime folder "app" acts as a router and main controller, it reflects the functions contained in "main.js".

All views, which correspond to routes and events declared in the configuration file "config.js" are contained in the "views" folder, they reflect the functions contained in "view.js".

The application is started from the launcher file "LAUNCH.html", if it has been previously executed and the configuration foresees the saving in JavaScript file (.js) it will try to resume first the previous session, alternatively will attempt to reload the last file loaded from the save folder "save". Then you are redirected to the index file "index.html" which will manage all directions in the app.

The storage into the application is provided by "localStorage" and "sessionStorage" browser APIs.

To appreciate features and functionality of individual functions read the documentation section app. functions and hooks.

Further details on customization and extensibility of appe are in the section Recipes.

Clone this wiki locally