mojito

Yahoo! Mojito

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

Quick Start

This quick start is intended for Mojito application developers. To contribute to the Mojito project, see Contributing Code to Mojito.

• Install the Mojito command-line tool:

   $ npm install -g mojito-cli
  

• Create an app:

   $ mojito create app hello
   $ cd hello
  

• Create a mojit:

   $ mojito create mojit HelloMojit
  

• Start the server:

   $ mojito start
  

• Go to http://localhost:8666/@HelloMojit/index

• Run Unit Tests:

   $ mojito test app .
  

• Generate documentation:

   $ mojito docs app hello
   
  

Mojito Git Branches

The default branch for the Mojito GitHub repository is develop. To clone the version of Mojito that is the same as the latest version of Mojito in the npm registry, explicitly request the master branch: git clone https://github.com/yahoo/mojito.git --branch master Mojito application developers should work with the master branch.

Mojito contributors, however, should clone and make pull requests to the develop branch. Before you start contributing, please read Contributing Code to Mojito.

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/

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.