Update readme with Firestore explanation and database example

curtgrimes · Nov 2, 2023 · e9572a1 · e9572a1
1 parent f383012
commit e9572a1
Show file tree

Hide file tree

Showing 2 changed files with 107 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -76,6 +76,12 @@ The ["share captions by link" feature](#share-captions-by-link-feature) requires
 
 If you are not using this feature, you don't need the Redis server.
 
+### Firebase
+
+This project uses Firebase for user authentication ([Firebase Authentication](https://firebase.google.com/docs/auth/)) and data storage ([Cloud Firestore](https://firebase.google.com/docs/firestore/)). Stored data included a user's preferences (under the `settings` key) and some other settings related to the "share captions" feature/experiment. Firebase can be configured with the `FIREBASE_*` environment variables listed in [.env.sample](./app/.env.sample).
+
+Firestore had a "users" collection. See [firestore-collection-example.json](./firestore-collection-example.json) for an example of what a user record looked like.
+
 ## Contributing
 
 This project is no longer maintained and is not accepting PRs.

diff --git a/firestore-collection-example.json b/firestore-collection-example.json
@@ -0,0 +1,101 @@
+{
+    "__collections__": {
+        "users": {
+            "00a7k4yCz5XhNopQsSTuhWbYZiZ2": {
+                "__collections__": {
+                    "privileges": {
+                        "share": {
+                            "telnet": true,
+                            "vanity": "delilah",
+                            "customDomain": "test.example.com",
+                            "__collections__": {}
+                        }
+                    },
+                    "rooms": {
+                        "Os1Z8vtWGw6Xi18bKaPL": {
+                            "__collections__": {}
+                        }
+                    },
+                    "settings": {
+                        "user": {
+                            "wordReplacements": [],
+                            "controls": {
+                                "layout": {
+                                    "larger": false
+                                },
+                                "volumeMeter": {
+                                    "show": true,
+                                    "sensitivity": "low"
+                                }
+                            },
+                            "alwaysAutostartOnLoad": true,
+                            "locale": {
+                                "userDefault": "en-CA",
+                                "from": "en-US"
+                            },
+                            "afterNoAudio": {
+                                "seconds": 2,
+                                "action": "lineBreak5"
+                            },
+                            "stabilizedThresholdMs": 0,
+                            "roomLeaderToken": null,
+                            "appearance": {
+                                "shadow": {
+                                    "color": "#000000",
+                                    "blurRadius": "0",
+                                    "offsetX": "0.05",
+                                    "offsetY": "0.05",
+                                    "opacity": "100"
+                                },
+                                "background": {
+                                    "color": "#000000",
+                                    "opacity": "100"
+                                },
+                                "text": {
+                                    "textSize": "2.5",
+                                    "textColorInterim": "#ffffff",
+                                    "letterSpacing": "0.1",
+                                    "fontVariant": "regular",
+                                    "textColor": "#ffffff",
+                                    "fontFamily": "Cousine",
+                                    "lineHeight": "1.6",
+                                    "alignment": {
+                                        "padding": "0.25",
+                                        "vertical": "full",
+                                        "horizontal": "full"
+                                    },
+                                    "textTransform": "uppercase"
+                                }
+                            },
+                            "channels": [],
+                            "censor": {
+                                "replaceWith": "nothing",
+                                "on": false
+                            },
+                            "donationDate": null,
+                            "share": {
+                                "expires": true,
+                                "ownerKey": null,
+                                "vanity": "",
+                                "url": null,
+                                "roomId": null,
+                                "urlType": "random",
+                                "expireDate": null,
+                                "on": false
+                            },
+                            "exp": [],
+                            "roomMembershipId": null,
+                            "chromelessWindow": {
+                                "top": 0,
+                                "left": 0,
+                                "width": 0,
+                                "height": 0
+                            },
+                            "__collections__": {}
+                        }
+                    }
+                }
+            }
+        }
+    }
+}