Skip to content

Commit

Permalink
Add folder to keep track of misc. scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
ekzhang committed Feb 23, 2021
1 parent b7e9a25 commit d5c109f
Show file tree
Hide file tree
Showing 7 changed files with 1,412 additions and 0 deletions.
1 change: 1 addition & 0 deletions scripts/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
credential.json
18 changes: 18 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Scripts

This folder contains miscellaneous scripts that interface with the Firebase
Admin SDK to perform one-off administrative functions. To run these scripts, you
need to have the secret key credentials corresponding to a service account,
which can be done by admin users following the
[instructions here](https://firebase.google.com/docs/admin/setup). Download the
secret, and save it to a file in this folder called `credential.json`.

After downloading the credentials file, you can run scripts with `npm install`
and `npm start`.

## Structure

The scripts are written in Node.js as functions and have access to the
`firebase-admin` SDK. The entry point is `src/index.js`, which imports and lists
all of the functions. These files might be somewhat messy, but it's better to
track these tools somewhere than to not keep them at all.
Loading

0 comments on commit d5c109f

Please sign in to comment.