Add docs to readme.

pull/217/head
Atul Varma 2021-08-22 12:14:52 -04:00
rodzic cc6b376c35
commit f16f6ff576
1 zmienionych plików z 27 dodań i 0 usunięć

Wyświetl plik

@ -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/