https://github.com/YahooArchive/mojito

[archiving soon] Yahoo! Mojito Framework
https://github.com/YahooArchive/mojito

Last synced: 30 days ago
JSON representation

[archiving soon] Yahoo! Mojito Framework

• Host: GitHub
• URL: https://github.com/YahooArchive/mojito
• Owner: YahooArchive
• License: bsd-3-clause
• Archived: true
• Created: 2012-03-29T19:41:48.000Z (over 12 years ago)
• Default Branch: develop
• Last Pushed: 2016-11-30T05:59:03.000Z (about 8 years ago)
• Last Synced: 2024-05-27T11:36:04.310Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 55.3 MB
• Stars: 1,570
• Watchers: 91
• Forks: 230
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        


# Yahoo! Mojito [![Build Status](https://secure.travis-ci.org/yahoo/mojito.svg?branch=develop)](http://travis-ci.org/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](https://github.com/yahoo/mojito/wiki/Contributing-Code-to-Mojito).

1. Install the Mojito command-line tool:

        $ npm install -g mojito-cli

1. Create an app:

        $ mojito create app hello

        $ cd hello

1. Create a mojit:

        $ mojito create mojit HelloMojit

1. Start the server:

        $ mojito start

1. Go to http://localhost:8666/@HelloMojit/index

1. Run Unit Tests:

        $ mojito test app .

1. 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](https://github.com/yahoo/mojito/wiki/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](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). 

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.