Helma NG is a JavaScript runtime and shell based on Rhino providing a ServerJS conformant module library and web application framework.
Pull request Compare This branch is 1548 commits behind hns:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
apps
bin
deb
debian
lib
modules
src/org/helma
.gitignore
LICENSE.txt
README.txt
build.xml

README.txt

Helma NG
========

Helma NG is a Javascript runtime and web application framework written in Java.
"NG" stands for "next generation", meaning that it is more of a rewrite of
Helma 1 than simply a new version.

Helma NG consists of several components that can be used together or alone:

  1) A compact JavaScript runtime environment based on Mozilla Rhino. It adds
     to Rhino a reloading module system that is compatible to the ServerJS
     Securable Module proposal.

  2) An interactive shell with support for autocompletion and history.

  3) A module library implemented in JavaScript, covering basic functionality
     such as extensions to the built-in objects, file I/O, logging, persistence,
     client and server side HTTP support and more.

For more information, check out the Helma NG homepage and wiki:

    http://dev.helma.org/ng/

Building Helma
==============

Helma requires Java 1.5 and uses Apache Ant as its build environment. If you have
these installed, building Helma NG is straightforward:

  Check out Helma NG from Git:

      git clone git://github.com/hns/helma-ng.git

  Change to the helma-ng directory and run ant to compile:

      ant jar

If this succeeds you should now have a file called run.jar and be ready to go.

JavaScript Runtime and Shell
============================

The Helma JavaScript runtime is based on Mozilla Rhino and supports
JavaScript 1.7 with partial support for JavaScript 1.8 features.

To run Helma NG, add the helma-ng/bin directory to your PATH environment
variable:

    export PATH=$PATH:/path/to/helma-ng/bin

To start a shell session, just run the helma command without any arguments:

    helma

To run a script simply pass it to helma on the command line:

    helma apps/demo/main.js

If you run a script that is contained in Helma's module path you can also
use the simpler abstract module name instead of the file name. For example,
to run the helma test suite:

    helma test/all

To create a new web application, use the admin/create script. This will copy
an simple skeleton app to the location you define. You can pass the
application directory as command line argument, or the script will prompt you
for it.

    helma admin/create [appdir]

Run helma with the -h or --help switch to get more information about available
command line options. For example, the -i or --interactive option allows you
to run an application and use the shell at the same time, which can be really
handy.

Module Path Setup
=================

Helma NG loads JavaScript resources using a module loader that is compliant with
the ServerJS Securable Modules proposal:

    https://wiki.mozilla.org/ServerJS/Modules/SecurableModules

Helma NG actually goes one step further and makes sure every module has its own
top level scope, so modules are fully isolated from each other, providing a
programming environment that resembles that of Python environment more than
the one of ordinary client-side JavaScript runtime.

Helma uses the concept of a module path to look up and load modules that is
similar to the PATH environment variable used to find executables on most
operating systems. By default, the module path consists of two entries:

    1. The application root, which is the parent directory of the command line
       script, or the current working directory if called without script
       argument.
    2. The system modules root, which corresponds to the modules directory in
       the Helma NG home directory.

Helma NG provides several ways to access and set the module path. The simplest
is to set the HELMA_MODULE_PATH environment variable, separating multiple entries
with ':' or whatever character is used to separate PATH entries on your system:

     export HELMA_MODULE_PATH=../foo/lib:../my/lib

Alternatively, you can define the module path using the helma.modulepath Java
system property, and you can add entries to the module path using the
addRepository() method in the helma/system module.

Module and Resource Loading
===========================

Helma NG provides three functions with different semantics to load modules:

require(moduleName)

    The require function provides the functionality defined in the ServerJS
    Securable Modules proposal. It tries to locate a module in the module path,
    loads it and returns its exports object.

import(moduleName)

    The import function builds on top of require, additionally setting a
    property in the calling module scope whose name is the name of the
    loaded module and whose value is the loaded module's exports object.

include(moduleName)

    The include function builds on top of require, additionally copying
    all exported properties of the loaded module to the calling module scope.

export(propertyName[, ...])

    The export function provides an alternative method to the exports object
    to define exported properties in a module by passing the names of exported
    properties as arguments.

addToClasspath(pathName)

    This function adds a jar file or directory to the classpath. By default,
    all jar files in the Helma NG lib directory are included in the classpath.

getResource(pathName)

    This looks for a file with the given path name in the module path and
    returns a resource object. This can be used to load resources other than
    JavaScript files using the same lookup rules as the module loader.

Web Framework
=============

The Helma Web Framework is a web application framework written mostly in JavaScript
built on top of the Helma Runtime.

To run the demo application that is part of Helma NG run the following command:

    helma apps/demo/main.js

This starts and serves the demo web app on port 8080:

    http://localhost:8080/

The demo app showcases a number of tools and libraries to build web apps.
As Helma NG is still pretty young, many features found in Helma 1.6 are still
missing, most notably a persistence layer. These features are currently being
implemented.

The exciting thing is that it will be possible to implement much of it in
Javascript, meaning you can help doing so without hacking on helma core.
The new modular concept will even allow to use Helma NG with several
frameworks, even on the same server instance.

Visit http://dev.helma.org/ng/ and join the Helma NG mailing list to keep up
with Helma NG core and module development!