HotDrink

HotDrink is a JavaScript library for User Interface programming. Instead of requiring programmers to write explicit event handlers, HotDrink derives user interface behavior from a declarative specification of data dependencies.

For a brief overview on the functionality HotDrink provides, see the HotDrink overview.

For a thorough introduction on how to use HotDrink, see How to use HotDrink.

You can find compiled versions of HotDrink on GitHub under releases.

Building

Building is performed with the make tool. Run make with no arguments to get a list of possible make targets. They are:

• hotdrink - Compile the HotDrink library; this is probably the target you want
• hotdrink.min - Compiled minified version of HotDrink library; same library, smaller file
• fn-worker - Include file for HotDrink's web worker framework; only needed if you want to write web workers using HotDrink's framework
• compile-dfa - A DFA compiler for models; this tool can make a more efficient constraint solver for certain types of constraint systems; it's unlikely that you'll need this
• qunit - QUnit tests; for testing purposes only
• howto - Export how-to documentation; note, however, that you can find this on GitHub
• all - all of the above
• clean - remove all created files

Build results may be found in the scripts directory, with the exception of the how-to, which is found in docs/howto/publish.

The following tools are required for building.

• The Node.js runtime is necessary to run the following tools
• The TypeScript compiler for compiling TypeScript files into JavaScript
• The mapcat tool for concatenating resulting map files.
• The uglify-js tool for creating minimized version.
• GNU Emacs with org mode version 8.3 for generating the how-to. Note that it's probably easier to download the generated how-to on GitHub under releases.

Project layout

This repository is organized as follows.

• docs - Documentation
  • docs/howto - The HotDrink how-to: in-depth instructions on using HotDrink
• src - Source code
  • src/apps - Stand-alone applications
  • src/hd - HotDrink source code
  • src/qunit - QUnit tests
  • src/workers - HTML5 web workers
• test - Files for testing
  • test/cases - Stand-alone web pages using HotDrink
  • test/models - JavaScript defining various models using HotDrink; no web pages
  • test/qunit - Harness for running QUnit tests
  • test/vis - Visualizer for viewing models

In addition, building HotDrink will create the following directories.

• modules - Compiled versions of each TypeScript module
• scripts - Build results
• tmp - Temporary compilation results

These directories are deleted by make clean.