Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Latest commit

 

History

History
101 lines (69 loc) · 4.2 KB

admin.md

File metadata and controls

101 lines (69 loc) · 4.2 KB
Raw

Administration tools

The functions folder also contains tools to administrate bedtime-writer.

Setup

These instructions will use bedtime-writer-dev as an example. Change the project accordingly if necessary.

Service account file

Go to https://console.firebase.google.com/u/0/project/bedtime-writer-dev/settings/serviceaccounts/adminsdk and click on "Generate new private key". You will download a JSON file that contains a secret key to connect to Firebase services.

Keep this file secure. Anybody with this file has basically all the rights on our project. Do not send it over the Internet (in particular, do not commit it). If you think there is any chance that someone was given access to it, revoke your access immediately. To do so, go to https://console.cloud.google.com/iam-admin/serviceaccounts?authuser=0&project=bedtime-writer-dev&hl=en, select the firebase-adminsdk account, go to Keys and remove your key (the key ID is in the JSON file).

Rename the file to service-account.json or service-account-dev.json and put it in the functions folder.

Run

Run firebase use bedtime-writer-dev.

Then, set the GOOGLE_APPLICATION_CREDENTIALS environment variable:

  • on Linux or macOS: export GOOGLE_APPLICATION_CREDENTIALS="service-account-dev.json"
  • on Windows PowerShell: $env:GOOGLE_APPLICATION_CREDENTIALS="service-account-dev.json"

This has to be done every time you close your shell.

Using the emulators

By default, the real Firebase servers are used. If you want to use the Firebase emulators, run them with npm run local_backend and add this content to .env.local:

USE_FIREBASE_EMULATORS=true

Note: if the Firebase emulators are not used even if the environment variable is set, it may be because you did not call initFirebase() of src/firebase_utils.ts in your script.

This command creates emulators with no data. We provide some tools to quickly add data from files (see below) but, as you can guess, it can be quite annoying to do so every time you want to launch the emulators. Thankfully, a shortcut is possible, the npm run lbd command, for "local backend (with) data". See below to configure it.

Run the tests

You can run the tests with npm test. These tests always use the emulators, so make sure they are launched!

Tools

  • npm run story_questions_set [questions.yaml]: set the story questions for the current project (on the emulator if USE_FIREBASE_EMULATORS is true). By default, admin_data/story/questions.yaml is used.
  • npm run compress_images [folder]: compress the images of the story choices. By default, admin_data/story/ is used.
  • npm run story_forms_gen: generate story forms and write them to the Firestore database.
  • npm run story_forms_cache: select a story form, generate all the stories for it, and write them to the Firestore database.
  • npm run story_forms_serve: copy a story form (and related story questions / cached stories) from the landing area to the serving area.

Start the local backend with pre-loaded data

First-time setup

The following commands must be run in the functions folder.

Make sure to set USE_FIREBASE_EMULATORS=true in .env.local and start the local backend: npm run local_backend

Fill it with some data. You can choose whichever data you want, a good start is npm run story_questions_set (run it in another terminal, you will be likely asked to set GOOGLE_APPLICATION_CREDENTIALS first).

Export the Firebase data with firebase emulators:export lbd. Firebase will write to lbd. This folder should never be committed!

Use

Compile the code in both functions (npm run build:watch).

Make sure to set USE_FIREBASE_EMULATORS=true in .env.local and start the local backend with npm run lbd. Your data previously saved should be restored. lbd is a shortcut for "local backend (with) data".

Use the Express admin interface

An admin interface made with Express allows to review the images generated by story_forms_cache to approve or regenerate them. You need the emulators running if you are using it locally. To launch the admin interface, first export GOOGLE_APPLICATION_CREDENTIALS for the right environment and then run npm run admin_interface.