Docs

[RyanCheungJF]

Goal: at least some minimal docs on the components/ functions

• main readme

For functions/src:

• src/development
• src/index
• src/init
• src/production

src/access

• pageAccess (@nguyenvukhang, help me double check this)
• updatePageAccess (@nguyenvukhang, help me double check this)

src/classes

• data
• firebase
• QR
• team
• user

src/data/schema/SOAR (I think this one no need, cause its just schema, maybe add a high level overview on main readme)

src/data/schema/TSS (Most of it is data classes)

• utils

src/data

• initializeCollections (@nguyenvukhang)
• writeSchema (@nguyenvukhang)

src/deletions

• clearCollection
• deleteDocs

src/production

• index

src/qr

• createQR
• index

src/schedule

• createSchedule (@nguyenvukhang, not too sure where cache is within firebase)
• getSchedule (@nguyenvukhang, unsure about the query pairs part)
• makeSchedule (@nguyenvukhang, same for the cache and types)

src/teams

• createTeams

src/tss

• getQuarterFinals
• index
• updatePoints
• updateSchedule

src/users

• assignUsers (this one might need more clarification, as I'm not too sure what's in the req body)
• createUsers
• deleteAllUsers
• firebase
• getUsers
• trigger

src/utils (Maybe for utils say in which situation you will need them + why)

• array
• exists
• firestore
• parseCsv
• response (khang, unsure what this does)
• schedule
• string
• teams
• user

For tests/src

Maybe a generic comments on what axios is, what this dir is for, how to use it? Maybe in main readme?