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 | | 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.

Getting Started

###Famo.us University

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. If you are new to Famo.us or to coding you will find that Famo.us University is the best place to get started.

Seed Projects

There are a number of seed projects to get you started with the various ways of consuming Famo.us

Global Seed

This project shows the easiest way to get started with Famo.us, using a version that loads on the global (window) object. This project requires zero tooling, and is ready to work out of the box. For speed and simplicity this seed project points at a version of Famo.us that lives on our CDN (content delivery network). You don't even have to do a git clone, you can get started right away simply by downloading the zip.

Requirejs Seed

This project can be used to get you started using Famo.us with the AMD module loading pattern via RequireJS. This project is created using the latest version of our Yeoman Generator (see below), and includes an entire tooling stack neccessary to bring your product to development.

Browserify Seed

This project can be used to get you started using Famo.us with the CommonJS module loading pattern with Browserify and npm. This seed project should be treated as experimental, it is for those who want to try and develop client side code using npm.

Yeoman Generator (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

• Guides and Examples can be found in the repo.
• Rendered versions of the source code reference documentation: docs.

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) 2015 Famous Industries, Inc.