README

RingoJS is a JavaScript runtime written in Java based on Mozilla Rhino.

It adds a number of features to Rhino that make it suitable for real-world, large-scale application development:

• A fast, auto-reloading, and CommonJS-compliant module loader.
• A rich set of modules covering I/O, logging, persistence, development tools and much more.
• Scalable HTTP server and client based on the Jetty project.
• Support for CommonJS packages to install or write additional software components.

For more information, visit the RingoJS web site: http://ringojs.org/

Building RingoJS

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

Check out Ringo using Git:

git clone git://github.com/ringo/ringojs.git

Change to the ringojs directory and run ant to compile:

ant jar

To build the documentation:

ant docs

Running RingoJS

It is recommended but not strictly required to add the ringojs bin directory to your PATH environment variable. If you don't you'll have to type the full path to the bin/ringo command in the examples below.

To start the Ringo shell, just run the ringo command without any arguments:

ringo

To run a script simply pass it to ringo on the command line. For example, to run the Ringo test suite:

ringo test/all.js

To run the demo web application on port 8080:

ringo apps/demo/main.js

Use the ringo-admin command to create a new web application or install packages. To create a blank Ringo web app:

ringo-admin create [appdir]

To install a package from a zip URL:

ringo-admin install [packageurl]

Learning more

If you have questions visit http://ringojs.org/ or join the RingoJS mailing list at http://groups.google.com/group/ringojs.

edit this page | list all pages | go home