Starter Kit

The Famo.us Starter Kit is a downloadable .ZIP file ↓ that contains a starter project and several other goodies to help those who are just beginning to learn Famo.us.

In the Starter Kit, you’ll find the following components:

The Famo.us platform, production-ready

The dist folder contains a collection of production-ready builds of Famo.us, including:

famous.css — the required Famo.us stylesheet. Make sure you link this stylesheet on any page using Famo.us.
famous.js — the full Famo.us library, commented and unminified. Ideal for development and testing. This variant of the library works with AMD-style module loading, e.g. var Engine = require('famous/core/Engine');.
famous.min.js — Famo.us minifieid. Ideal for production. Uses AMD-style module loading, e.g. var Engine = require('famous/core/Engine');.
famous-globals.js — a “globals” build of Famo.us, commented and unminified. Ideal for development and testing. A global famous object is exported; use global-style module loading, e.g.: var Engine = famous.core.Engine;.
famous-globals.min.js — the Famo.us “globals” build, minifieid. Uses global-style module loading, e.g. var Engine = famous.core.Engine;.

API docs

In the docs folder you’ll find our API documentation, generated from YUIDoc-formatted comments in our source code.

Examples

The examples folder contains simple examples of all of the modules included with Famo.us. The folders inside are structured exactly like the folders in the library itself.

Reference tutorials

The Starter Kit is packaged with two reference tutorials (see the reference-tutorials folder), which walk you through the process of building a complete application with Famo.us.

The slideshow folder shows how to build a photo-slideshow application
The timbre folder shows how to build a fun music exploration app

Source code

The src folder contains the complete source code of the platform, unbundled.

Starter project

In the starter-project folder, you’ll find the main files and boilerplate code you’ll need to start building a Famo.us app. Try opening src/index.html in your browser.

Next: What’s Included in Famo.us »