docs: clean up README, move git recovery tip to CONTRIBUTING

[Copilot]

README had structural issues: duplicate env var listings, verbose testing section, vague service account instructions, and a contributor-only git tip mixed into user-facing docs.

Summary

• What changed?

  • Removed duplicate env var listings; the 5 service-account credential vars (PROJECT_ID, PRIVATE_KEY_ID, PRIVATE_KEY, CLIENT_EMAIL, CLIENT_X509_CERT_URL) now appear once under Google Service Account with an accurate description of the runtime flow
  • Removed FIREBASE_ADMINSDK_FILE from the env var list — it is a local Python variable in app.py, not a user-facing env var
  • Removed erroneous python generate_service_account_file.py CLI instruction — the script has no entrypoint and is only called internally by config.py at startup
  • Corrected the service account description: SERVICE_ACCOUNT_FILE points to a JSON template; at startup generate_file() reads that template and overrides the 5 credential fields with values from the environment (not the other way around)
  • Collapsed the two separate ngrok/Cloudflare blocks into a single concise Testing Locally section
  • Condensed Health Check: merged curl/make health into one block, collapsed status-code bullets to one line
  • Removed If You Commit to main by Mistake from README; added it to CONTRIBUTING.md where it belongs

• Why was it needed?

  • Duplicate listings, incorrect env var names, a misleading CLI command, and unstructured prose made setup harder to follow; the git recovery tip is contributor-specific and cluttered the user-facing README

Validation

• Local checks passed (make test)
• Runtime check done where relevant (make health)
• CI checks are green

AI-Assisted Review (if applicable)

• I used AI assistance for parts of this change
• I manually reviewed all AI-generated code
• I verified no secrets/credentials were added

Risk & Rollback

• Risk level: Low
• Rollback plan (if needed): Revert commit 935c00c

Original prompt

Problem

The README.md file contains redundant and non-relevant information that should be cleaned up and reorganized for better clarity and readability.

Issues to Address

1. Redundant Environment Variables Section - The environment variables are listed twice (once in a general list and again in the Google Service Account section)
2. Verbose TESTING section - Contains redundant information about ngrok and cloudflare tunneling that could be consolidated
3. Unnecessary workflow section - The "If You Commit to main by Mistake" section is not relevant to the main README and should be removed or moved to CONTRIBUTING.md
4. Inconsistent formatting - Some sections have inconsistent markdown formatting
5. Vague descriptions - Some sections like "Google Service Account" have poorly formatted extract instructions
6. Redundant health check examples - The health check section could be more concise

Proposed Changes

• Remove duplicate environment variable listings
• Consolidate TESTING section to be more concise
• Remove "If You Commit to main by Mistake" section (it belongs in CONTRIBUTING.md)
• Improve formatting and clarity
• Keep only the most essential and relevant information for users
• Ensure the README focuses on core setup and usage instructions

This pull request was created from Copilot chat.

---

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

[Copilot]

Pull request overview

This PR reorganizes user-facing documentation by simplifying setup/testing instructions in README.md and moving contributor-only git recovery guidance into CONTRIBUTING.md.

Changes:

• Reformat and de-duplicate the environment variable list and restructure the Google Service Account instructions in README.md.
• Consolidate local tunneling/testing instructions and condense the health-check section in README.md.
• Move “If You Commit to main by Mistake” from README.md into CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
README.md	Cleans up setup, service account, local testing, and health-check documentation.
CONTRIBUTING.md	Adds the git recovery workflow section intended for contributors.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

This paragraph says the listed variables are "extracted automatically from that file", but generate_service_account_file.generate_file() actually reads PROJECT_ID, PRIVATE_KEY_ID, PRIVATE_KEY, CLIENT_EMAIL, and CLIENT_X509_CERT_URL from the environment and merges them into the JSON loaded from SERVICE_ACCOUNT_FILE. Please reword to avoid implying they are read from the JSON file, and make it clear these env vars must be set (or adjust the code to fall back to values already present in the JSON).

[Copilot]

FIREBASE_ADMINSDK_FILE is listed as a required environment variable, but the codebase does not read an env var by that name (Firebase credentials come from SERVICE_ACCOUNT_DATA, which is built from SERVICE_ACCOUNT_FILE + the individual credential env vars). This entry is likely misleading and should be removed or replaced with the actual required configuration key(s).

Suggested change

	- `FIREBASE_ADMINSDK_FILE`
	- `SERVICE_ACCOUNT_DATA`

[DaTiC0]

Pull request overview

This PR reorganizes user-facing documentation by simplifying setup/testing instructions in README.md and moving contributor-only git recovery guidance into CONTRIBUTING.md.

Changes:

• Reformat and de-duplicate the environment variable list and restructure the Google Service Account instructions in README.md.
• Consolidate local tunneling/testing instructions and condense the health-check section in README.md.
• Move “If You Commit to main by Mistake” from README.md into CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
README.md	Cleans up setup, service account, local testing, and health-check documentation.
CONTRIBUTING.md	Adds the git recovery workflow section intended for contributors.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@copilot analyze requirements and fix it

[Copilot]

Pull request overview

This PR reorganizes user-facing documentation by simplifying setup/testing instructions in README.md and moving contributor-only git recovery guidance into `CONTRIBUT...

Fixed in 935c00c. Three issues addressed:

1. FIREBASE_ADMINSDK_FILE removed from the env var list — it's a local Python variable in app.py (assigned from app.config.get('SERVICE_ACCOUNT_DATA')), not an env var.
2. python generate_service_account_file.py command removed — the script has no CLI entrypoint; generate_file() is only called internally by config.py at startup.
3. Service account description corrected — the 5 credential env vars (PROJECT_ID, PRIVATE_KEY_ID, etc.) are read from the environment and used to override the corresponding fields in the JSON template loaded via SERVICE_ACCOUNT_FILE, not extracted from it.