[SCL-81] Square API Backend Metrics: Total Donations

[sandaiiyahh]

• Added new GCP function: cookbook to call Square Orders API for getting total donations

[linear]

SCL-85 Back-End

SCL-81 Square Metrics

Page information

• Desktop View
• Mobile View

Judy has already done some research on how to query the Square API to get the information that we need. Let's convert that into actual code that is hosted on Heroku, as a Firebase function, or otherwise. If the former, the implementer can make a new repo, if the latter, we can either do a new repo or piggy-back on the APAHM project.

We need to create a micro-service that has our Square API keys (talk to jacob for access) that can return a set of metrics (namely two as listed below). This should have a 1-hr caching layer to not approach Square's API usage thresholds. Then, a front-end embeddable element should be designed to consume and render those metrics.

The two metrics that need to be retrieved are:

• Total number of cookbook items sold (factoring in quantity in orders)
• Total donations to SCL via Square (may change later)
  • The SCL Donation item can be used
  • This is less important and not required for MVP

This is a large amount of work and may take 2 sprints to complete. 2 engineers may also take it and split the work into front-end / back-end.

An example micro-service backend that implemented caching and was deployed on Heroku can be found here.

For the front-end component, the background should be transparent as we will color it from within the Weebly section. It should be done in the Weebly repo in the custom-elements folder. Code should be vanilla HTML / CSS / JS for embedding on the Weebly site. You can use the HTML Preview extension for quick local development.

Font: https://fonts.google.com/specimen/Plus+Jakarta+Sans

Acceptance Criteria

• Create and stand up a micro-service to retrieve metrics from square.
• The micro-service caches square data on a 1-hr basis
• The embeddable front-end can consume our micro-service and displays information accordingly