Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 2.09 KB

README.md

File metadata and controls

64 lines (37 loc) · 2.09 KB
Raw

First

Instructions on how to manually deploy the backend, and build and deploy the front-end.

The commands are to be executed in the first folder.

Requirements

  • You have a Firebase project created
    • it has "Blaze" plan with these enabled:
      • Cloud Firestore
      • Cloud Functions
      • Realtime Database
      • Hosting
    • it has an "application" created (for authentication)

Manual deployment

The manual deployment is done using Docker. Your Firebase credentials are only momentarily kept in the development machine; cleared after successful deployment.

This means:

  • it's more secure than using firebase login on the development machine and keeping credentials permanently there
  • you will need to re-authenticate if you run the script again

Steps

$ ./deploy.sh

This asks you to log into the Firebase project.

Hint: On macOS, press Cmd(⌘) and double click on the URL in the terminal, to open it.

Did you reach the end?

Visit the stated URL - is there an app?

This may be your first deployment!. Let's celebrate for a while!! 🎉🎉🎪🤹‍♀️🎺

Note: Let the author know if there were any problems (by filing a GitHub Issue). This stage is important because it's early on in the onboarding. But it's also done "just once" - you'll likely turn to CI/CD if you remain using the template.

Limitations (optional)

The point of the first deployment is to get you up and running, fast.

We've left out Grafana Cloud configuration, with the idea that you'll set it up in the CI/CD phase.

However, if you wish to only run manual deployments, this is what you'd do:

  • Create a METRICS_API_KEY secret in Google Cloud > Secrets Manager
  • Provide the PROM_USER_ID and LOKI_USER_ID values via tmp/functions/.env to the Cloud Function needing them

Without this, metrics and central logs are stored in the Realtime Database. With this, they are shipped further to Grafana Cloud UI.

The CI/CD documentation shows where you can find the said values.