https://github.com/networked-aframe/naf-firebase-adapter

networked-aframe Firebase network adapter
https://github.com/networked-aframe/naf-firebase-adapter

Last synced: 10 months ago
JSON representation

networked-aframe Firebase network adapter

• Host: GitHub
• URL: https://github.com/networked-aframe/naf-firebase-adapter
• Owner: networked-aframe
• License: mit
• Created: 2017-10-25T23:20:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T08:26:38.000Z (over 3 years ago)
• Last Synced: 2025-04-08T01:35:01.404Z (about 1 year ago)
• Language: JavaScript
• Size: 1.89 MB
• Stars: 14
• Watchers: 2
• Forks: 6
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Networked-AFrame Firebase Adapter

Network adapter for [networked-aframe](https://github.com/haydenjameslee/networked-aframe) that uses Firebase as a backend.

## Running the Example

```

git clone https://github.com/networked-aframe/naf-firebase-adapter

cd naf-firebase-adapter

npm install # or use yarn

# Set firebase credentials in example/index.html

npm start

```

With the server running, browse the example at http://localhost:8080. Open another browser tab and point it to the same URL to see the other client.

## Setting Up Firebase

Firebase is a "serverless" network solution provided by Google. In NAF's case it can be used to establish connections between clients in a peer-to-peer fashion, without having to host a signalling (connection) server.

Steps to setup Firebase:

1. [Sign up for a Firebase account](https://firebase.google.com/)

2. Create a new Firebase project

3. Go to Database -> Realtime Database -> Rules and change them to the following (warning: not safe for production, just developing)

```javascript

    {

      "rules": {

        ".read": true,

        ".write": true

      }

    }

```

4. Click publish

5. Go back to the project overview

6. Click "Add Firebase to your web app"

7. Copy the credentials into your HTML page

## Use in an existing project

After setting up firebase include and configure `naf-firebase-adapter`.

```html

  

  

  

  

  

  

  /script>

  

  

    window.firebaseConfig = {

      authType: 'none',

      apiKey: 'your-api-key',

      authDomain: 'xxx.firebaseapp.com',

      databaseURL: 'https://xxx.firebaseio.com',

      projectId: "your-projectId",

      storageBucket: "your-storageBucket",

      messagingSenderId: "your-messagingSenderId",

      appId: "your-appId",

      measurementId: "your-measurementId"

    };

  

    

   

  

```