Skip to content

mk-5/gdx-fireapp

Repository files navigation

GDX Fireapp

A libGDX cross-platform API for Firebase.

Build Status Maven Central Coverage

Getting Started

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

Android guide - iOS guide - HTML guide - ProGuard required rules

Core

implementation "pl.mk5.gdx-fireapp:gdx-fireapp-core:$gdxFireappVersion"

Android

implementation "pl.mk5.gdx-fireapp:gdx-fireapp-android:$gdxFireappVersion"

iOS

implementation "pl.mk5.gdx-fireapp:gdx-fireapp-ios:$gdxFireappVersion"

GWT

implementation "pl.mk5.gdx-fireapp:gdx-fireapp-html:$gdxFireappVersion"

 

The latest version was built using libGDX 1.9.12, robovm 2.3.1, gwt 2.8.2, iOS Firebase sdk 8.x, android Firebase BOM 25.12.0

 

Basics

The API is like a bridge between libGDX app and Firebase sdk. It covers Firebase functionality, so if you have some knowledge of the Firebase SDK, using this API should be intuitive.

 

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

GdxFIRApp.inst().configure();

Firebase Analytics should start working just after this step.

 

Examples

To see some examples, please go to examples wiki page.

 

Useful links

 

What's next?

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

 

Features

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

 

Platforms

  • Android
  • iOS (RoboVM)
  • 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.