Famo.us/Angular Starter Kit

Famo.us is a JavaScript platform that helps you build beautiful, cross-platform mobile and web apps.

It is the only framework that provides an open source 3D layout engine fully integrated with a 3D physics-based animation engine that can render to DOM, Canvas, or WebGL.

Famo.us/Angular is a framework based on AngularJS that allows you to create and organize Famo.us apps using AngularJS. Using F/A, it's easy to integrate Famo.us with new or existing AngularJS apps.

Getting started is easy. In addition to this starter kit, these resources are available:

Contents

Starter

Starter is a seed project for creating a new Angular app with Famo.us/Angular.

You can dive into the code at starter/app.

Since this example uses angular-ui-router, you'll need to serve this example using some sort of server (rather than just opening index.html from your computer.) The simplest way is to make use of gulp as it's set up in this repo. Check out starter/README.md for details on getting started with gulp.

You can also find this project at https://github.com/thomasstreet/famous-angular-starter

Docs

famous-angular-docs is a copy of the docs site, which is also available at https://famo.us/angular.

These docs are generated from the comments in the library code, so you can also check out the docs from the library itself.

Examples

This Angular app has several routes that you can visit to see a handful of simple examples of apps in F/A. You can explore the controllers for these mini-apps in examples/app/scripts/controllers/ and the templates in examples/app/views/. A listing of the different routes can be found at examples/app/scripts/app.js

Since this example uses angular-ui-router, you'll need to serve this example using some sort of server (rather than just opening index.html from your computer.) The simplest way is to make use of gulp as it's set up in this repo. Check out famous-angular-starter/README.md for details on getting started with gulp.

You can also find this project at https://github.com/thomasstreet/famous-angular-examples

FAQ

In the faq folder, you'll find a high level document that answers some high-level questions. You don't have to read it to get started, but it's a good first place to check if you have any questions.

Info

For overview-level and deeper technical information, check out the documents in Info.

Copyright (c) 2014 Famous Industries, Inc.