| 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 | ## Installation
|
| 11 |
|
| 12 | ### via GitHub
|
| 13 |
|
| 14 | $ git clone git://github.com/yahoo/mojito.git
|
| 15 | $ cd mojito
|
| 16 | $ npm install -g .
|
| 17 | $ npm install .
|
| 18 |
|
| 19 | ### via npm
|
| 20 |
|
| 21 | $ npm install -g mojito
|
| 22 |
|
| 23 | ## Quick Start
|
| 24 |
|
| 25 | Create an app and install local Mojito:
|
| 26 |
|
| 27 | $ mojito create app hello
|
| 28 | $ cd hello
|
| 29 | $ npm install .
|
| 30 |
|
| 31 | Create a mojit:
|
| 32 |
|
| 33 | $ mojito create mojit HelloMojit
|
| 34 |
|
| 35 | Start the server:
|
| 36 |
|
| 37 | $ mojito start
|
| 38 |
|
| 39 | Go to URL:
|
| 40 |
|
| 41 | http://localhost:8666/@HelloMojit/index
|
| 42 |
|
| 43 | Run Unit Tests:
|
| 44 |
|
| 45 | $ mojito test app .
|
| 46 |
|
| 47 | Generate documentation:
|
| 48 |
|
| 49 | $ mojito docs app hello
|
| 50 |
|
| 51 | ## Documentation
|
| 52 |
|
| 53 | ### General
|
| 54 |
|
| 55 | * Mojito Home Page - http://developer.yahoo.com/cocktails/mojito
|
| 56 | * Mojito Docs Navigation - http://developer.yahoo.com/cocktails/mojito/docs/
|
| 57 | * Mojito FAQ - http://developer.yahoo.com/cocktails/mojito/docs/faq/
|
| 58 | * Mojito Introduction - http://developer.yahoo.com/cocktails/mojito/docs/intro/
|
| 59 | * Mojito Getting Started - http://developer.yahoo.com/cocktails/mojito/docs/getting_started/
|
| 60 |
|
| 61 | ### Contributing to Documentation
|
| 62 |
|
| 63 | Mojito documentation is present in /docs directory. To generate HTML documentation run the following commands
|
| 64 | from the documentation directories.
|
| 65 |
|
| 66 | $ cd docs/dev_guide
|
| 67 | $ make html
|
| 68 |
|
| 69 | Please note that in order to generate the documentation you will need [Sphinx](http://sphinx-doc.org/).
|
| 70 |
|
| 71 | ### API Documentation
|
| 72 |
|
| 73 | * Running the following command will generate API docs and locally save them to `./artifacts/docs/mojito/`
|
| 74 | `$ mojito docs mojito`
|
| 75 | * View the Mojito API documentation on YDN: http://developer.yahoo.com/cocktails/mojito/api/
|
| 76 |
|
| 77 | ## Discussion/Forums
|
| 78 |
|
| 79 | http://developer.yahoo.com/forum/Yahoo-Mojito
|
| 80 |
|
| 81 | ## Licensing and Contributions
|
| 82 |
|
| 83 | 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).
|
| 84 |
|
| 85 | 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.
|