libGDX Firebase API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

GDX Fireapp

A libGDX cross-platform API for Firebase.

Build Status Download Coverage

Getting Started

The first thing you should do is installing Firebase SDK and add gradle dependencies.

Core

compile "pl.mk5.gdx-fireapp:gdx-fireapp-core:1.+"

Android

compile "pl.mk5.gdx-fireapp:gdx-fireapp-android:1.+"

iOS

compile "pl.mk5.gdx-fireapp:gdx-fireapp-ios-moe:1.+"

GWT

compile "pl.mk5.gdx-fireapp:gdx-fireapp-html:1.+"

 

The latest version was built using libGDX 1.9.8, multi-os-engine 1.4.3, gwt 2.8.0, iOS firebase sdk 5.x,
android firebase sdk 16.x

 

Basics

API is something like bridge between libGDX app and firebase sdk. It's cover firebase functionality so if you have some knowledge about firebase SDK - using this API should be intuitive for you.

 

To initialize Firebase SDK just put this line somewhere in your app initialization code:

GdxFIRApp.instance().configure();

Firebase Analytics should start working just after this step.

If you added Fabric/Crashlytics to your project you should initialize it also:

GdxFIRCrash.instance().initialize();

 

Firebase SDK communication is done with following classes:

 

Examples

For some examples please look at examples wiki page.

 

Useful links

 

What's next?

  • Better wiki/documentation
  • Facebook, github authorization
  • Messaging
  • Upload task monitoring

 

Features

  • Analytics
  • Authentication
  • Database
  • Storage
  • Crash raporting (Crashlytics)
  • Messaging

 

Platforms

  • Android
  • iOS (Multi-os Engine)
  • GWT

 

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.