Add docs to readme.
rodzic
cc6b376c35
commit
f16f6ff576
27
README.md
27
README.md
|
@ -68,6 +68,33 @@ To deploy the project to GitHub Pages, run:
|
||||||
npm run deploy
|
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/
|
[NodeJS]: https://nodejs.org/en/
|
||||||
[Nina Paley]: https://blog.ninapaley.com/
|
[Nina Paley]: https://blog.ninapaley.com/
|
||||||
[Atul Varma]: https://portfolio.toolness.org/
|
[Atul Varma]: https://portfolio.toolness.org/
|
||||||
|
|
Ładowanie…
Reference in New Issue