open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Ian Philips 2022-04-25 09:29:28 -06:00
parent 0afaec2621
commit 8efd0b6f9c
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
functions/README.md
View File

@ -19,7 +19,7 @@ Adapted from https://firebase.google.com/docs/functions/get-started
2. `$ yarn` to install JS dependencies 2. `$ yarn` to install JS dependencies
3. `$ firebase login` to authenticate the CLI tools to Firebase 3. `$ firebase login` to authenticate the CLI tools to Firebase
4. `$ firebase use dev` to choose the dev project 4. `$ firebase use dev` to choose the dev project
5. `$ firebase functions:config:get > .runtimeconfig.json` to cache secrets for local dev (TODO: maybe not for Manifold) 5. `$ firebase functions:config:get > .runtimeconfig.json` to cache secrets for local dev
### Preparing local Firestore database: ### Preparing local Firestore database:
@ -40,6 +40,13 @@ Adapted from https://firebase.google.com/docs/functions/get-started
2. `$ yarn dev:emulate` in `/web` to connect to emulators with the frontend 2. `$ yarn dev:emulate` in `/web` to connect to emulators with the frontend
1. Note: emulated database is cleared after every shutdown 1. Note: emulated database is cleared after every shutdown
## Firestore Commands
- `db:update-local-from-remote` - Pull the remote db from Firestore to local, also calls:
- `db:backup-remote` - Exports the remote dev db to the backup folder on Google Cloud Storage (called on every `db:update-local-from-remote`)
- `db:rename-remote-backup-folder` - Renames the remote backup folder (called on every `db:backup-remote` to preserve the previous db backup)
- `db:backup-local` - Save the local db changes to the disk (overwrites existing)
## Debugging ## Debugging
- Find local logs directly in the shell that ran `$ yarn dev` - Find local logs directly in the shell that ran `$ yarn dev`