nuǝW pǝuoᴉʇᴉsoԀ ʎlǝʌᴉʇɐƃǝN

npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

This package has been deprecated

Author message:

[DEPRECATED] Please run 'npm install famous'

famo.us

0.2.2 • Public • Published

Famo.us CommonJS

This version of Famo.us has been converted to CommonJS format and is ready for use with tools like browserify and commonjs-everywhere. The only changes are:

  1. Removing the define block from each file
  2. Unindenting the code in the define block
  3. Modifying require calls to use relative paths (in cases where AMD root paths were used)
  4. Adding this Famo.us CommonJS section to the root README.md. Below this section is the unaltered readme from the official (AMD) Famo.us repo

For an example with browserify, see the tool used to generate this version, Famo.us CommonJS Converter.

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

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. Since we use git submodules, all subfolders will be unpopulated unless you initialize and update your submodules. To clone from the command line, run

git clone git@github.com:Famous/famous.git path/to/folder
cd path/to/folder
git submodule update --init

Or clone with the --recursive flag for a conveninent the one-liner

git clone git@github.com:Famous/famous.git --recursive path/to/folder

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 for using Famo.us.

Famous.git Package

This package contains the submodules necessary to be productive in Famo.us. They are all hosted on our github organization.

Submodule Description
core.git The low level componentry of Famo.us, plus the required famous.css stylesheet.
events.git Events are used for communication between objects in Famous.
inputs.git The inputs library is used to interpret user input to the device.
math.git A simple math library used throughout the core.
modifiers.git Implementations of the core/Modifier pattern which output transforms to the render tree.
physics.git Core engine controlling animations via physical simulation.
surfaces.git Surfaces extend core/Surface and encapsulate common HTML tags like <img> and <canvas>.
transitions.git Transitions are used to create animation, usually by providing input to a Modifier.
utilities.git Utilities hosts various helper classes and static methods.
views.git Views are visually interactable components for use in applications.
widgets.git Widgets are small visually interactable components for use in applications with their own styling.

Documentation

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

Community

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 license@famo.us for further inquiries.

Copyright (c) 2014 Famous Industries, Inc.

install

npm i famo.us

Downloadsweekly downloads

3

version

0.2.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability