| 1 | <img src="http://www.blackducksoftware.com/files/images/Rookie_2012-125.png" alt="Black Duck OS 2012 Rookie of the Year" align="right" vspace="-50" />
|
| 2 |
|
| 3 | # Yahoo! Mojito
|
| 4 |
|
| 5 | Mojito is the JavaScript library implementing Cocktails, a JavaScript-based
|
| 6 | on-line/off-line, multi-device, hosted application platform.
|
| 7 |
|
| 8 | [](http://travis-ci.org/yahoo/mojito)
|
| 9 |
|
| 10 |
|
| 11 | ## Quick Start
|
| 12 |
|
| 13 | This quick start is intended for Mojito application developers. To contribute to the Mojito project,
|
| 14 | see [Contributing Code to Mojito](https://github.com/yahoo/mojito/wiki/Contributing-Code-to-Mojito).
|
| 15 |
|
| 16 |
|
| 17 | 1. Install the Mojito command-line tool:
|
| 18 |
|
| 19 | $ npm install -g mojito-cli
|
| 20 |
|
| 21 | 1. Create an app:
|
| 22 |
|
| 23 | $ mojito create app hello
|
| 24 | $ cd hello
|
| 25 |
|
| 26 | 1. Create a mojit:
|
| 27 |
|
| 28 | $ mojito create mojit HelloMojit
|
| 29 |
|
| 30 | 1. Start the server:
|
| 31 |
|
| 32 | $ mojito start
|
| 33 |
|
| 34 | 1. Go to http://localhost:8666/@HelloMojit/index
|
| 35 |
|
| 36 | 1. Run Unit Tests:
|
| 37 |
|
| 38 | $ mojito test app .
|
| 39 |
|
| 40 | 1. Generate documentation:
|
| 41 |
|
| 42 | $ mojito docs app hello
|
| 43 |
|
| 44 | ## Mojito Git Branches
|
| 45 |
|
| 46 | The default branch for the Mojito GitHub repository is `develop`. To clone the version of Mojito that is the same as
|
| 47 | the latest version of Mojito in the npm registry, explicitly request the `master` branch: `git clone https://github.com/yahoo/mojito.git --branch master`
|
| 48 | Mojito application developers should work with the `master` branch.
|
| 49 |
|
| 50 | Mojito contributors, however, should clone and make pull requests to the `develop` branch. Before you
|
| 51 | start contributing, please read [Contributing Code to Mojito](https://github.com/yahoo/mojito/wiki/Contributing-Code-to-Mojito).
|
| 52 |
|
| 53 |
|
| 54 | ## Documentation
|
| 55 |
|
| 56 | ### General
|
| 57 |
|
| 58 | * Mojito Home Page - http://developer.yahoo.com/cocktails/mojito
|
| 59 | * Mojito Docs Navigation - http://developer.yahoo.com/cocktails/mojito/docs/
|
| 60 | * Mojito FAQ - http://developer.yahoo.com/cocktails/mojito/docs/faq/
|
| 61 | * Mojito Introduction - http://developer.yahoo.com/cocktails/mojito/docs/intro/
|
| 62 | * Mojito Getting Started - http://developer.yahoo.com/cocktails/mojito/docs/getting_started/
|
| 63 |
|
| 64 |
|
| 65 | ### API Documentation
|
| 66 |
|
| 67 | * Running the following command will generate API docs and locally save them to `./artifacts/docs/mojito/`
|
| 68 | `$ mojito docs mojito`
|
| 69 | * View the Mojito API documentation on YDN: http://developer.yahoo.com/cocktails/mojito/api/
|
| 70 |
|
| 71 | ## Discussion/Forums
|
| 72 |
|
| 73 | http://developer.yahoo.com/forum/Yahoo-Mojito
|
| 74 |
|
| 75 | ## Licensing and Contributions
|
| 76 |
|
| 77 | Mojito is licensed under a [BSD license](https://github.com/yahoo/mojito/blob/master/LICENSE.txt). To contribute to the Mojito project, please see [Contributing](https://github.com/yahoo/mojito/wiki/Contributing-Code-to-Mojito).
|
| 78 |
|
| 79 | The Mojito project is a [meritocratic, consensus-based community project](https://github.com/yahoo/mojito/wiki/Governance-Model) which allows anyone to contribute and gain additional responsibilities.
|