Helma Logo
main list history

Version 10 by hannes on 21. September 2009, 15:46

3=== Installation[ant]: http://ant.apache.org/
4[download]: http://github.com/hns/helma-ng/downloads
5[github]: |http://github.com/hns/helma-ng/tree/master
6[group]: http://groups.google.com/group/helma-ng
7[irc]: http://helma.server-side-javascript.org/hopbot/
8[demo]: http://helma-ng.appspot.com/
5Helma requires Java 1.5 to run and uses *Apache Ant|http://ant.apache.org/* as its build tool. ### Installation
7To get started with Helma NG either *download the latest release|http://githubrequires Java 1.com/hns/helma-ng/downloads* or get the current snapshot *from Github|http://github5 to run and uses [Apache Ant][ant] as its build tool.com/hns/helma-ng/tree/master*, either by clicking the download button or using the following git command:
9<tt style="font-weight:bold;color:#d33;">git clone git://github.com/hns/helma-ng.git</tt>To get started with Helma NG either [download the latest release][download] or get the current snapshot [from Github][github], either by clicking the download button or using the following git command:
11`git clone git://github.com/hns/helma-ng.git`
12
14<tt style="font-weight:bold;color:#d33;">ant jar</tt>`ant jar`
18=== ### Using the shell
22<tt style="font-weight:bold;color:#d33;">/bin/helma</tt>`bin/helma`
24This should start a shell session with a <tt>helma&gt;</tt> `helma>` prompt. You can enter and evaluate any JavaScript expression. You can scroll through your session history using the <Up> and <Down> keys, hitting <Tab> will try to auto-complete your current input. Use the <tt>include</tt>`include`, <tt>require</tt>`require`, or <tt>import</tt> `import` functions to load any Helma NG modules:
26<tt>helma>     helma> include('helma/file');
27    helma> var file = new File('README.txt');
28    helma> file.open();
29    true
30    helma> file.readln();
31    Helma NG
32    helma> file.close();
33true</tt>    true
28=== ### Running the demo app
32<tt style="font-weight:bold;color:#d33;">/bin/helma `bin/helma apps/demo/main.js</tt>js`
34This will start the *Helma [Helma NG demo app|http://helma-ng.appspot.com/* app][demo] on port 8080. Enter the following URL in your browser to access the app:
36http://localhost:8080/<http://localhost:8080/>
38You can also run an application and the shell at the same time by adding the -i `-i` or --interactive `--interactive` option before the application name: 
40<tt style="font-weight:bold;color:#d33;">/bin/helma `bin/helma -i apps/demo/main.js</tt>js`
42Use the -h `-h` or --help flag `--help` options for more information on available options.
44=== ### Starting your own application
48<tt style="font-weight:bold;color:#d33;">/bin/helma `bin/helma admin/create [app directory]</tt>directory]`
52<tt style="font-weight:bold;color:#d33;">/bin/helma `bin/helma appname/main.js</tt>js`
54If you like Helma NG drop a note on the *mailing list|http://groups.google.com/group/helma-ng* [mailing list][group] or the *#helma [#helma channel on irc.freenode.net|http://helma.server-side-javascript.org/hopbot/*!net][irc]!
55

Version 9 by hannes on 16. June 2009, 10:22

7To get started with Helma NG either *download the latest release|http://github.com/hns/helma-ng/downloads* or check it out from either *Subversion|https://devget the current snapshot *from Github|http://github.helma.org/svn/helma-ng/trunk* or *Git|http://github.com/hns/helma-ng/tree/master*. For Subversion, either by clicking the command is:download button or using the following git command:
8
9<tt style="font-weight:bold;color:#d33;">svn co https&#58;//dev.helma.org/svn/helma-ng/trunk/ helma-ng</tt>
10
11For Git:

Version 8 by hannes on 19. May 2009, 15:07

64If you like Helma NG drop a note on the *mailing list|http://groups.google.com/group/helma-ng* or the #helma IRC *#helma channel on irc.freenode.net!net|http://helma.server-side-javascript.org/hopbot/*!

Version 7 by hannes on 19. May 2009, 15:06

53
54=== Starting your own application
55
56To start hacking on your own Helma application, use the admin/create script to create a new app:
57
58<tt style="font-weight:bold;color:#d33;">/bin/helma admin/create [app directory]</tt>
59
60If you don't pass the app directory on the command line the script will prompt you for it. Once the application has been created you can start it by running its main.js script:
61
62<tt style="font-weight:bold;color:#d33;">/bin/helma appname/main.js</tt>
63
64If you like Helma NG drop a note on the *mailing list|http://groups.google.com/group/helma-ng* or the #helma IRC channel on irc.freenode.net!

Version 6 by hannes on 19. May 2009, 14:10

23Once you have built the jar files you should be able to start the Helma *Helma NG shellshell|shell*. Just run the helma script in the bin directory without arguments:
27This should start a shell session with a <tt>helma&gt;</tt> prompt. You can enter and evaluate any JavaScript expression. You can scroll through your session history using the <Up> and <Down> keys, hitting <Tab> will try to auto-complete your current input. Use the <tt>include</tt> <tt>include</tt>, <tt>require</tt>, or <tt>require</tt> <tt>import</tt> functions to load any Helma NG modules:

Version 5 by hannes on 19. May 2009, 13:33

7To get started with Helma NG you need to either *download the latest release|http://github.com/hns/helma-ng/downloads* or check it out from either *Subversion|https://dev.helma.org/svn/helma-ng/trunk* or *Git|http://github.com/hns/helma-ng/tree/master*. For Subversion, the command is:

Version 4 by hannes on 04. May 2009, 16:17

5Helma requires Java 1.5 to run and uses *Apache Ant|http://ant.apache.org/* as its build tool.
6
14Helma NG uses *Apache Ant|http://ant.apache.org/* as its build tool. Once you have Apache Ant installed change Change to the helma-ng directory you just checked out and run ant it with the "jar" target:

Version 3 by hannes on 30. April 2009, 10:56

Version 2 by hannes on 30. April 2009, 10:55

1This is a very short tutorial on how to install and start using Helma NG.
2
18=== Starting Using the shell

Version 1 by hannes on 30. April 2009, 10:54

1=== Installation
3To get started with Helma NG you need to check it out from either *Subversion|https://dev.helma.org/svn/helma-ng/trunk* or *Git|http://github.com/hns/helma-ng/tree/master*. For Subversion, the command is:
4
5<tt style="font-weight:bold;color:#d33;">svn co https&#58;//dev.helma.org/svn/helma-ng/trunk/ helma-ng</tt>
6
7For Git:
8
9<tt style="font-weight:bold;color:#d33;">git clone git://github.com/hns/helma-ng.git</tt>
10
11Helma NG uses *Apache Ant|http://ant.apache.org/* as its build tool. Once you have Apache Ant installed change to the helma-ng directory you just checked out and run ant it with the "jar" target:
12
13<tt style="font-weight:bold;color:#d33;">ant jar</tt>
14
15If this worked then you should now have a file called lib/helma.jar.
16
17=== Starting the shell
18
19Once you have built the jar files you should be able to start the Helma NG shell. Just run the helma script in the bin directory without arguments:
20
21<tt style="font-weight:bold;color:#d33;">/bin/helma</tt>
22
23This should start a shell session with a <tt>helma&gt;</tt> prompt. You can enter and evaluate any JavaScript expression. You can scroll through your session history using the <Up> and <Down> keys, hitting <Tab> will try to auto-complete your current input. Use the <tt>include</tt> or <tt>require</tt> functions to load any Helma NG modules:
24
25<tt>helma> include('helma/file');
26helma> var file = new File('README.txt');
27helma> file.open();
28true
29helma> file.readln();
30Helma NG
31helma> file.close();
32true</tt>
33
34=== Running the demo app
35
36To run an actual web application simply pass the main file of the app to the helma command:
37
38<tt style="font-weight:bold;color:#d33;">/bin/helma apps/demo/main.js</tt>
39
40This will start the *Helma NG demo app|http://helma-ng.appspot.com/* on port 8080. Enter the following URL in your browser to access the app:
41
42http://localhost:8080/
43
44You can also run an application and the shell at the same time by adding the -i or --interactive option before the application name: 
45
46<tt style="font-weight:bold;color:#d33;">/bin/helma -i apps/demo/main.js</tt>
47
48Use the -h or --help flag for more information on available options.