https://github.com/rageagainstthepixel/com.rest.firebase.realtime-database

A non-official Firebase RESTful Realtime-Database Client for Unity (UPM)
https://github.com/rageagainstthepixel/com.rest.firebase.realtime-database

database firebase firebase-realtime-database openupm realtime-database unity unity-3d unity3d upm upm-package

Last synced: 3 months ago
JSON representation

A non-official Firebase RESTful Realtime-Database Client for Unity (UPM)

• Host: GitHub
• URL: https://github.com/rageagainstthepixel/com.rest.firebase.realtime-database
• Owner: RageAgainstThePixel
• License: mit
• Created: 2021-06-17T15:30:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-19T06:34:37.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T22:27:18.727Z (9 months ago)
• Topics: database, firebase, firebase-realtime-database, openupm, realtime-database, unity, unity-3d, unity3d, upm, upm-package
• Language: C#
• Homepage:
• Size: 255 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Firebase.Realtime-Database

A non-official [Firebase](https://firebase.google.com/) RESTful Realtime-Database Client for the [Unity](https://unity.com/) Game Engine.

[![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xQgMW9ufN4)

[![openupm](https://img.shields.io/npm/v/com.rest.firebase.realtime-database?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.rest.firebase.realtime-database/)

***All copyrights, trademarks, logos, and assets are the property of their respective owners.***

## Installing

### Via Unity Package Manager and OpenUPM

- Open your Unity project settings

- Add the OpenUPM package registry:

  - `Name: OpenUPM`

  - `URL: https://package.openupm.com`

  - `Scope(s):`

    - `com.rest.firebase`

    - `com.utilities`

![scoped-registries](Firebase.Realtime-Database/Packages/com.rest.firebase.realtime-database/Documentation~/images/package-manager-scopes.png)

- Open the Unity Package Manager window

- Change the Registry from Unity to `My Registries`

- Add the `Firebase.Realtime-Database` package

### Via Unity Package Manager and Git url

- Open your Unity Package Manager

- Add package from git url: `https://github.com/RageAgainstThePixel/com.rest.firebase.realtime-database.git#upm`

  > Note: this repo has dependencies on other repositories! You are responsible for adding these on your own.

  - [com.rest.firebase.authentication](https://github.com/RageAgainstThePixel/com.rest.firebase.authentication)

  - [com.utilities.async](https://github.com/RageAgainstThePixel/com.utilities.async)

---

## Documentation

```csharp

// Create a firebase authentication client

var authClient = new FirebaseAuthenticationClient();

// Create a firebase storage client

var dbClient = new FirebaseRealtimeDatabaseClient(authClient);

// Sign the user in

await authClient.SignInWithEmailAndPasswordAsync(email, password);

// Sets json data at the specified endpoint.

await dbClient.SetDataSnapshotAsync("test", "{\"value\":42}");

// Gets json data at the specified endpoint.

var snapshotValue = await dbClient.GetDataSnapshotAsync("test");

// snapshotValue == {"value":42}

// Deletes data at the specified endpoint.

await dbClient.DeleteDataSnapshotAsync("test");

```

## Additional Packages

- [Firebase.Authentication](https://github.com/RageAgainstThePixel/com.rest.firebase.authentication)

- [Firebase.Firestore](https://github.com/RageAgainstThePixel/com.rest.firebase.firestore)

- [Firebase.Storage](https://github.com/RageAgainstThePixel/com.rest.firebase.storage)