Add comprehensive setup and service account documentation#287
Draft
Copilot wants to merge 2 commits into
Draft
Conversation
Co-authored-by: pauljohanneskraft <15239005+pauljohanneskraft@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Service Account & Setup Documentation
Add comprehensive setup and service account documentation
Oct 3, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #287 +/- ##
==========================================
- Coverage 82.43% 82.12% -0.30%
==========================================
Files 91 91
Lines 3607 3607
Branches 894 894
==========================================
- Hits 2973 2962 -11
- Misses 600 637 +37
+ Partials 34 8 -26 see 12 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Addresses #[issue_number] by providing comprehensive documentation on setting up the ENGAGE-HF Firebase infrastructure from scratch, including detailed service account configuration and step-by-step user onboarding procedures.
Changes
New Documentation: SETUP.md
Created a comprehensive 607-line setup guide covering the complete deployment lifecycle:
Service Accounts (Core Addition)
cloudfunctionsserviceaccount@[PROJECT_ID].iam.gserviceaccount.com) - used by sensitive operations likedefaultSeed,customSeed,updateStaticData,deleteUser,enrollUser, and otherslimited-cloudfunction-sa@[PROJECT_ID].iam.gserviceaccount.com) - used by standard Cloud FunctionsSetup Instructions
User Onboarding (Complete Flow)
Additional Sections
Updated: README.md
Added a prominent "Getting Started" section immediately after the project description that:
Why This Matters
Previously, teams setting up ENGAGE-HF Firebase had to piece together information from various sources and the codebase itself. This documentation provides:
Testing
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.