Git Product home page Git Product logo

angularfire's Introduction

AngularFire

Build Status Version

AngularFire is the officially supported AngularJS binding for Firebase. Firebase is a full backend so you don't need servers to build your Angular app. AngularFire provides you with the $firebase service which allows you to easily keep your $scope variables in sync with your Firebase backend.

Downloading AngularFire

In order to use AngularFire in your project, you need to include the following files in your HTML:

<!-- AngularJS -->
<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.0-beta.17/angular.min.js"></script>

<!-- Firebase -->
<script src="https://cdn.firebase.com/js/client/1.0.18/firebase.js"></script>

<!-- AngularFire -->
<script src="https://cdn.firebase.com/libs/angularfire/0.8.0/angularfire.min.js"></script>

Use the URL above to download both the minified and non-minified versions of AngularFire from the Firebase CDN. You can also download them from the root of this GitHub repository. Firebase and AngularJS can be downloaded directly from their respective websites.

You can also install AngularFire via Bower and the dependencies will be downloaded automatically:

$ bower install angularfire --save

Once you've included AngularFire and its dependencies into your project, you will have access to the $firebase service.

You can also start hacking on AngularFire in a matter of seconds on Nitrous.IO:

Hack firebase/angularfire on Nitrous.IO

Getting Started with Firebase

AngularFire requires Firebase in order to sync data. You can sign up here for a free account.

Documentation

The Firebase docs have a quickstart, guide, and full API reference for AngularFire.

We also have a tutorial to help you get started with AngularFire.

Join our Firebase + Angular Google Group to ask questions, provide feedback, and share apps you've built with Firebase and Angular.

Contributing

If you'd like to contribute to AngularFire, you'll need to run the following commands to get your environment set up:

$ git clone https://github.com/firebase/angularfire.git
$ cd angularfire        # go to the angularfire directory
$ npm install -g grunt  # globally install grunt task runner
$ npm install -g bower  # globally install Bower package manager
$ npm install           # install local npm build / test dependencies
$ bower install         # install local JavaScript dependencies
$ grunt install         # install Selenium server for end-to-end tests
$ grunt watch           # watch for source file changes

grunt watch will watch for changes in the /src/ directory and lint, concatenate, and minify the source files when a change occurs. The output files - angularfire.js and angularfire.min.js - are written to the /dist/ directory. grunt watch will also re-run the unit tests every time you update any source files.

You can run the entire test suite via the command line using grunt test. To only run the unit tests, run grunt test:unit. To only run the end-to-end Protractor tests, run grunt test:e2e.

In addition to the automated test suite, there is an additional manual test suite that ensures that the $firebaseSimpleLogin service is working properly with the authentication providers. These tests can be run with grunt test:manual. Note that you must click "Close this window", login to Twitter, etc. when prompted in order for these tests to complete successfully.

angularfire's People

Contributors

0x-r4bbit avatar allansideas avatar anantn avatar apai4 avatar arunthampi avatar bendrucker avatar clkao avatar donomans avatar elkorn avatar holic avatar hooloovooblu avatar jeffbcross avatar johnsoftek avatar katowulf avatar mchcoastal avatar mikepugh avatar ngedmundas avatar nickmerwin avatar philippbosch avatar pkaminski avatar rachelhigley avatar rmontgomery429 avatar robertdimarco avatar rosslavery avatar sanderboom avatar sararob avatar startupandrew avatar thomasboyt avatar thomasweiser avatar tomsaffell avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.