https://github.com/greenhousegames/firebase-reporting

The client-side only solution to reporting with Firebase
https://github.com/greenhousegames/firebase-reporting

firebase metrics reporting

Last synced: 10 days ago
JSON representation

The client-side only solution to reporting with Firebase

• Host: GitHub
• URL: https://github.com/greenhousegames/firebase-reporting
• Owner: greenhousegames
• License: mit
• Created: 2016-10-05T16:20:27.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-15T00:56:47.000Z (over 7 years ago)
• Last Synced: 2024-04-26T04:04:41.757Z (7 months ago)
• Topics: firebase, metrics, reporting
• Language: JavaScript
• Homepage:
• Size: 75.2 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Firebase Reporting

The client-side only solution to reporting with [Firebase](https://firebase.google.com)

[![Build Status](https://travis-ci.org/greenhousegames/firebase-reporting.svg)](https://travis-ci.org/greenhousegames/firebase-reporting)

[![npm version](https://badge.fury.io/js/%40greenhousegames%2Ffirebase-reporting.svg)](https://badge.fury.io/js/%40greenhousegames%2Ffirebase-reporting)

## Live Products

This library is being used by the following apps:

- [Bash Dot](https://www.greenhousegames.com/games/bashdot)

## Overview

Firebase Reporting provides the ability to generate reports on data stored in firebase without needing an alternate reporting database or server!  Firebase reporting does all metric calculations on the client using transactions in firebase, ensuring the metrics are reliably calculated regardless of the number of clients attempting to updated the reports.

Firebase reporting is designed to provide simple metrics on the data.  For complex reporting, it is suggested to use an alternate database for better performance.

## Setup

### Templates

Use one of the following templates to get started quickly with Firebase Reporting:

- [JQuery Template](https://github.com/greenhousegames/firebase-reporting-jquery)

- [Angular Template](https://github.com/greenhousegames/firebase-reporting-angular)

### Manual

Add Firebase Reporting to an existing project using npm:

```bash

npm install firebase-reporting --save

```

## Integration

Firebase Reporting can be included in a project using the following code:

```javascript

var FirebaseReporting = require('@greenhousegames/firebase-reporting');

var reporting = new FirebaseReporting(config);

```

The FirebaseReporting constructor takes the following configuration object:

```

{

  firebase: 'object', // reference in firebase for where to store results

  separator: 'string' // string used as separator in firebase database keys (defaults to '~~')

}

```

## API

...