History

mantikoros 03f36cf954 User profile (#44 ) * add id, userId to comment * change user info cloud function and script; move cleanUsername to common * change user info script * fix rules * add fund button: useLocation hook * profile page * merge * profile stuff * avatar uploading to storage bucket * changeUserInfo: use transaction * Styles for profile page * Edit mode for profile, and more styles Co-authored-by: James Grugett <jahooma@gmail.com>		2022-02-03 21:04:56 -06:00
..
src	User profile (#44 )	2022-02-03 21:04:56 -06:00
.gitignore	initial commit	2021-12-10 12:10:30 -06:00
package.json	Yarn workspaces (#42 )	2022-02-01 15:25:51 -06:00
README.md	DX: Cloud Functions tooling	2022-01-16 01:59:05 -05:00
tsconfig.json	Folds (#34 )	2022-01-21 17:21:46 -06:00
yarn.lock	Stripe (#22 )	2022-01-07 16:56:14 -06:00

README.md

NOTE: Adapted from One Word's /functions doc. Fix any errors you see!

Firestore Cloud Functions

This is code that doesn't make sense on the frontend client, e.g.

Long-running or slow operation (database)
Tasks that need to be run every so often (syncing email list to Mailjet)
Anything we should't trust to clients (secrets, auth)

If you want to make and test changes, you'll have to do a bit of setup...

Installing

Adapted from https://firebase.google.com/docs/functions/get-started

$ cd functions to switch to this folder
$ yarn global add firebase-tools to install the Firebase CLI globally
$ yarn to install JS dependencies
$ firebase functions:config:get > .runtimeconfig.json to cache secrets for local dev (TODO: maybe not for Manifold)
$ firebase use dev to choose the dev project

Developing locally

$ firebase login if you aren't logged into Firebase via commandline yet.
$ yarn dev to spin up the emulators The Emulator UI is at http://localhost:4000; the functions are hosted on :5001. Note: You have to kill and restart emulators when you change code; no hot reload =(
Connect to emulators by enabling functions.useEmulator('localhost', 5001)

Debugging

Find local logs directly in the shell that ran $ yarn dev
Find deployed logs here

Deploying

$ firebase use prod to switch to prod
$ yarn deploy to push your changes live! (Future TODO: auto-deploy functions on Git push)

Secrets management

Secrets are strings that shouldn't be checked into Git (eg API keys, passwords). We store these using environment config on Firebase Functions. Some useful workflows:

Set a secret: $ firebase functions:config:set stripe.test_secret="THE-API-KEY"
Preview all secrets: $ firebase functions:config:get
Cache for local dev:$ firebase functions:config:get > .runtimeconfig.json