rajeshvv/mojito

Yahoo! Mojito Framework

Yahoo! Mojito

Mojito is the JavaScript library implementing Cocktails, a JavaScript-based on-line/off-line, multi-device, hosted application platform.

Installation

via GitHub

$ git clone git://github.com/yahoo/mojito.git
$ cd mojito
$ npm install -g .
$ npm install .

via npm

$ npm install -g mojito

Quick Start

Create an app and install local Mojito:

$ mojito create app hello
$ cd hello
$ npm install .

Create a mojit:

$ mojito create mojit HelloMojit

Start the server:

$ mojito start

Go to URL:

http://localhost:8666/@HelloMojit/index

Run Unit Tests:

$ mojito test app .

Generate documentation:

$ mojito docs app hello

Documentation

General

• Mojito Home Page - http://developer.yahoo.com/cocktails/mojito
• Mojito Docs Navigation - http://developer.yahoo.com/cocktails/mojito/docs/
• Mojito FAQ - http://developer.yahoo.com/cocktails/mojito/docs/faq/
• Mojito Introduction - http://developer.yahoo.com/cocktails/mojito/docs/intro/
• Mojito Getting Started - http://developer.yahoo.com/cocktails/mojito/docs/getting_started/

Contributing to Documentation

Mojito documentation is present in /docs directory. To generate HTML documentation run the following commands from the documentation directories.

$ cd docs/dev_guide
$ make html

Please note that in order to generate the documentation you will need Sphinx.

API Documentation

• Running the following command will generate API docs and locally save them to ./artifacts/docs/mojito/ $ mojito docs mojito
• View the Mojito API documentation on YDN: http://developer.yahoo.com/cocktails/mojito/api/

Discussion/Forums

http://developer.yahoo.com/forum/Yahoo-Mojito

Licensing and Contributions

Mojito is licensed under a BSD license. To contribute to the Mojito project, please see Contributing.

The Mojito project is a meritocratic, consensus-based community project which allows anyone to contribute and gain additional responsibilities.