kjaikeerthi / famous

Famo.us is a JavaScript framework for everyone who wants to build beautiful experiences on any device

Famo.us

Welcome to the Famo.us GitHub repo. If you are interested in evaluating Famo.us, we are now in open beta.

RESOURCE	LINK
DOWNLOAD	Famo.us Starter Kit
LEARN	Famo.us University
DOCS	Documentation
HELP	IRC Channel
DEMOS	Mobile Interactive Demos (built by the community)
ANGULAR INTEGRATION	Famo.us/Angular
ANGULAR DOWNLOAD	Angular Starter Kit

About

Famo.us is a free and open source JavaScript platform for building mobile apps and desktop experiences. What makes Famo.us unique is its JavaScript rendering engine and 3D physics engine that gives developers the power and tools to build native quality apps and animations using pure JavaScript. Famo.us runs on iOS, Android, Kindle and Firefox devices and integrates with Angular, Backbone, Meteor and Facebook React. Famo.us University is a free live coding classroom that teaches all levels of developers how to utilize Famo.us to build beautiful experiences on every screen.

Installation

Simple Installation (Famo.us Starter Kit)

To get up and running quickly, download our starter kit. We've loaded it with examples, demos, reference documentation, and higher-level guides.

Advanced Installation (Grunt Toolbelt)

If you would like to scaffold an app with Famo.us from the command line, install our yeoman generator via npm.

npm install -g yo grunt-cli bower generator-famous
mkdir newProject
cd newProject
yo famous
grunt serve

Preparing your project for distribution is then as simple as:

grunt

Contributing

Cloning this repository directly is primarily for those wishing to contribute to our codebase. Check out our contributing instructions to get involved.

Note: cloning only provides the Famo.us folder with all Famo.us code, but it does no application scaffolding. You will additionally need to create your own index.html, and include the famous.css file that is included in famous/core. Require.js is currently a hard dependency to work off of the Famo.us head.

Documentation

• High-level documentation: guides.
• Rendered versions of the source code reference documentation: docs.
• Small examples of each Famo.us component: examples repository.

Community

• If you would like to report a bug, please check the issues section in our contributing instructions.
• Join us in our IRC channel #famous at irc.freenode.net. Freenode maintains this getting started guide for those new to IRC.
• For contributors, read more instructions in CONTRIBUTING.md.

Licensing information

• Famo.us' client-side development package is licensed under the Mozilla public license version 2.0. More information can be found at Mozilla.
• Mozilla also maintains an MPL-2.0 FAQ that should answer most questions you may have about the license.
• Contact [email protected] for further inquiries.

Copyright (c) 2014 Famous Industries, Inc.