Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mk-5/gdx-fireapp
libGDX Firebase API
https://github.com/mk-5/gdx-fireapp
cross-platform firebase libgdx
Last synced: 12 days ago
JSON representation
libGDX Firebase API
- Host: GitHub
- URL: https://github.com/mk-5/gdx-fireapp
- Owner: mk-5
- License: apache-2.0
- Created: 2017-09-12T06:43:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T10:58:43.000Z (7 months ago)
- Last Synced: 2024-08-02T07:08:34.134Z (3 months ago)
- Topics: cross-platform, firebase, libgdx
- Language: Java
- Homepage:
- Size: 14.6 MB
- Stars: 65
- Watchers: 12
- Forks: 21
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-libgdx - gdx-fireapp - Cross-platform API for Firebase. (Resources / Services)
README
# GDX Fireapp
A libGDX cross-platform API for Firebase.
[ ![Build Status](https://travis-ci.com/mk-5/gdx-fireapp.svg?branch=master)](https://travis-ci.com/mk-5/gdx-fireapp) [_![Maven Central](https://img.shields.io/maven-central/v/pl.mk5.gdx-fireapp/gdx-fireapp-core)_](https://search.maven.org/search?q=g:pl.mk5.gdx-fireapp) [_![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mk-5_gdx-fireapp&metric=coverage)_](https://sonarcloud.io/dashboard?id=mk-5_gdx-fireapp)
## Getting Started
The first thing you should do is install Firebase SDK and add gradle dependencies.
[Android guide](https://github.com/mk-5/gdx-fireapp/wiki/Android-guide) - [iOS guide](https://github.com/mk-5/gdx-fireapp/wiki/iOS-Guide) - [HTML guide](https://github.com/mk-5/gdx-fireapp/wiki/GWT-guide) - [ProGuard required rules](https://github.com/mk-5/gdx-fireapp/wiki/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:
```java
GdxFIRApp.inst().configure();
```**Firebase Analytics** should start working just after this step.
## Examples
To see some examples, please go to [examples wiki page](https://github.com/mk-5/gdx-fireapp/wiki/Examples).
## Useful links
- [Javadoc](http://javadoc.io/doc/pl.mk5.gdx-fireapp/gdx-fireapp-core)
- [Wiki](https://github.com/mk-5/gdx-fireapp/wiki)
## What's next?
- Better wiki/documentation
- Cloud Firestore
- Facebook, github authorization
- Messaging
- Upload task monitoring
## Features
- [x] Analytics
- [x] Authentication
- [x] Database
- [x] Storage
- [x] Crash reporting (Crashlytics)
- [ ] Messaging
## Platforms
- [x] Android
- [x] iOS (RoboVM)
- [x] 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](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.