# firebase.starter

> experimental wrapper for angularfire and geofire

Latest version **0.1.8** (published 2016-02-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install firebase.starter
pnpm add firebase.starter
yarn add firebase.starter
bun add firebase.starter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2016-02-18 |
| First published | 2015-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+15 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Brian Pietravalle |
| Maintainers | bpietravalle |
| Keywords | firebase, geofire, angularfire |

## Links

- npm: https://www.npmjs.com/package/firebase.starter
- Repository: https://github.com/bpietravalle/fireStarter
- Homepage: https://github.com/bpietravalle/fireStarter#readme
- Issues: https://github.com/bpietravalle/fireStarter/issues
- npm.io page: https://npm.io/package/firebase.starter

## Dependencies (5)

- [angular](https://npm.io/package/angular.md) ~1.4.4
- [geofire](https://npm.io/package/geofire.md) ~3.2.3
- [firebase](https://npm.io/package/firebase.md) ~2.3.2
- [coveralls](https://npm.io/package/coveralls.md) ^2.11.6
- [angularfire](https://npm.io/package/angularfire.md) ~1.1.3

## Recent versions

- 0.1.8 (latest) — 2016-02-18
- 0.1.7 — 2016-02-18
- 0.1.6 — 2016-01-19
- 0.1.6-0 — 2015-12-07
- 0.1.5 — 2015-11-28
- 0.1.5-8 — 2015-11-27
- 0.1.5-6 — 2015-11-25
- 0.1.5-5 — 2015-11-25
- 0.1.5-4 — 2015-11-24
- 0.1.5-3 — 2015-11-24
- 0.1.5-2 — 2015-11-24
- 0.1.5-1 — 2015-11-24
- 0.1.5-0 — 2015-11-23
- 0.1.4 — 2015-11-21
- 0.1.3 — 2015-11-18
- … 2 more at https://npm.io/package/firebase.starter/versions

## README

# FireStarter

[![Build Status](https://travis-ci.org/bpietravalle/fireStarter.svg?branch=master)](https://travis-ci.org/bpietravalle/fireStarter)
[![npm version](https://badge.fury.io/js/firebase.starter.svg)](https://badge.fury.io/js/firebase.starter)
[![Coverage Status](https://coveralls.io/repos/bpietravalle/fireStarter/badge.svg?branch=master&service=github)](https://coveralls.io/github/bpietravalle/fireStarter?branch=master)

FireStarter is a very simple wrapper for [angularFire](https://github.com/firebase/angularfire) and [Geofire](https://github.com/firebase/geofire-js).


## Installation & Setup

```bash
$ npm install firebase.starter --save
```

```bash
$ bower install firebase.starter --save
```

1.) Include FireStarter in your app dependencies.

```javascript
angular.module("yourApp",['firebase.starter']);
```
2.) Define your root url in a config block using the `setRoot` method.

```javascript

(function(){
    "use strict";

    angular.module("yourApp")
			.constant("YOURURL","https://your-firebase.firebaseio.com");
			.config(function(fireStarterProvider,YOURURL){
				 fireStarterProvider.setRoot(YOURURL);
			});

})();
```

3.) Inject fireStarter into your angular service.

```javascript

(function(){
    "use strict";

    angular.module("yourApp")
	 .factory("yourFactory", yourFactory);

	 /** @ngInject */
	 function yourFactory(fireStarter){

	 }

})();
```
## Usage

Firestarter can take up to three arguments

```javascript
	 fireStarter(type, path, flag);
```
1. _type_: the specific API you want to access. Options include: "array","auth", "geo", "object", or "ref".

2. _path_: the path of the child node you wish to create.  This argument should be passed as an array
of strings.  However, if there is only a single item in the array, you can also
just pass the argument as a string.  Also, you do not need to pass a _path_ argument if _type_ is set to "auth".

3. _flag_: if you already have a firebaseRef and simply want to wrap it in angularFire, then set the _path_ argument to 
the given firebaseRef and set this argument to _true_, otherwise leave this argument blank.


### Thanks!
The Geofire portion is largely due to [Mike Pugh](https://github.com/mikepugh/)'s awesome [wrapper](https://github.com/mikepugh/AngularGeofire).
Thanks!


### Contributing

Yes, please.  Below should get you setup.


```bash
$ git clone https://github.com/bpietravalle/fireStarter.git
$ cd fireStarter
$ npm i && bower i # install dependencies
$ gulp test #run test suite once
$ gulp test:auto #watch files and run tests continually
```
Any pending tasks associated with this repo are tracked [here](https://www.pivotaltracker.com/n/projects/1512608).

---
_Source: https://npm.io/package/firebase.starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._