miletus
v1.0.0
Published
Typescript API library for TMS Miletus.
Downloads
4
Readme
Table of Contents
About The Project
Miletus (named after Thales of Miletus) started off as a project for TMS WEB Core to enable embedding web pages in desktop applications.
It uses HTML, JS, CSS (optionally along with other resources) to produce native applications for multiple platforms from one code base. If that sounds familiar to you then you have probably already came accross Electron, the most well-known framework for doing this.
So what's the difference? The main difference from Electron is the usage of the browser rendering engine available on your operating system, which significantly cuts down the application size and the number of output files.
While this is a pro in terms of size, it's also a con as you need to make sure that a given system is prepared for a Miletus application. Check our Requirements section for more information on this.
Miletus comes in 2 parts:
API library
: Contains all the functionalities to interact with the operating system. This of course only works if the application is bundled with the packager.Packager
: Bundles your html, css, js, ... files into an application.
The Miletus API library is not strictly tied to Node.js. While it is an option to install the API library from npm, we also provide a precompiled JavaScript distribution that is ready to use.
Getting Started
You can install a local copy of this API library through npm.
npm install miletus
Alternatively you can use the precompiled JavaScript distribution from the build
folder.
Usage
Please refer to the Documentation