First Steps

This is a very short introduction on how to use Ringo. The Docs section has more detailed documentation.

If you don't find what you are looking for please tell us on the mailing list or in the IRC channel!

Starting the Ringo Shell

Run the ringo script in the bin directory without arguments:

$ ./bin/ringo

This should start a shell session with a >> prompt. Use the include, require, or import functions to load any RingoJS modules.

>> var fs = require('fs');
>> var file = fs.open('README.md');
>> var lines = [line for (line in file)]; 

Tips:

• Hitting Tab will try to auto-complete your current input.
• You can scroll through your session history using the Up and Down keys
• Ringo supports most of JavaScript 1.8 and ECMAScript 5 - you can read more about that here.

Running the demo webapp

Simply pass the main file of the app to the ringo command:

$ bin/ringo apps/demo/main.js

This will start the RingoJS demo app on port 8080. Access the app in your browser by going to http://localhost:8080/

Tips:

• You can also run an application and the shell at the same time by adding the -i or --interactive option before the application name
• Use Ringo's -h or --help options for more information on available options.

Starting your own application

To start hacking on your own RingoJS application, use the ringo-admin create script to create a new app:

$ bin/ringo-admin create [app directory]

If 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:

$ bin/ringo [app directory]/main.js

edit this page | list all pages | go home