diff --git a/README.md b/README.md index f902bf8..7a7e777 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,33 @@ To deploy the project to GitHub Pages, run: npm run deploy ``` +## Firebase support + +The website features optional Firebase integration. + +Currently, the details for the integration are hard-coded +into the application code; see `lib/firebase.tsx` for details. + +Currently, the Firebase project that we integrate with needs +to have the following configured: + +* Cloud Firestore should be enabled with a collection called + `compositions` and the following rules: + + ``` + rules_version = '2'; + service cloud.firestore { + match /databases/{database}/documents { + match /{document=**} { + allow read: if true; + allow write: if false; + } + } + } + ``` + +* The GitHub sign-in provider must be enabled. + [NodeJS]: https://nodejs.org/en/ [Nina Paley]: https://blog.ninapaley.com/ [Atul Varma]: https://portfolio.toolness.org/