Initial commit 🚀

networked-aframe · Oct 25, 2017 · 0dc2cc9 · 0dc2cc9
commit 0dc2cc9
Show file tree

Hide file tree

Showing 16 changed files with 5,532 additions and 0 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+  "presets": ["env"]
+}
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,7 @@
+{
+  "extends": ["prettier"],
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": "error"
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.DS_Store
+node_modules/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Hayden Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,70 @@
+# 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 -> 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
+<html>
+<head>
+  <script src="https://aframe.io/releases/0.7.0/aframe.min.js"></script>
+  <script src="https://unpkg.com/networked-aframe/dist/networked-aframe.min.js"></script>
+  <!-- Include naf-firebase-adapter *after* networked-aframe -->
+  <script src="https://unpkg.com/naf-firebase-adapter/dist/naf-firebase-adapter.min.js"></script>
+  <script src="https://www.gstatic.com/firebasejs/4.0.0/firebase.js"></script>
+
+  <!-- Set the Firebase credentials -->
+  <script>
+    window.firebaseConfig = {
+      authType: 'none',
+      apiKey: 'your-api-key',
+      authDomain: 'xxx.firebaseapp.com',
+      databaseURL: 'https://xxx.firebaseio.com'
+    };
+  </script>
+</head>
+<body>
+    <!-- Set adapter to firebase -->
+   <a-scene networked-scene="
+        adapter: firebase;
+    ">
+  </a-scene>
+</body>
+</html>
+```