Skip to content

README: live link, features, architecture and engineering highlights - #32

Merged
MCCProgrammer merged 1 commit into
mainfrom
docs/readme-showcase
Oct 28, 2026
Merged

MCCProgrammer merged 1 commit into
mainfrom
docs/readme-showcase

Conversation

@MCCProgrammer

Copy link
Copy Markdown
Owner

What

The README still said "in development" and listed the v1 features as planned. This PR changes it to match the live project:

  • Status: links the live site, https://extpulse.mccprogrammer.com.
  • Badges: adds the SonarQube Cloud quality gate and coverage badges, next to CI and CodeQL.
  • What it does: replaces "Planned (v1)" with a list of what works today.
  • Architecture: a Mermaid diagram of the app, the VM, the stores, the monitoring, the backups and CI. I rendered it with mermaid-cli and checked the layout.
  • Engineering highlights:
    • tests against recorded store responses, plus a weekly run against the live stores;
    • window functions in the stats SQL;
    • the two security chains;
    • Terraform at 0 € with quotas;
    • CI/CD with rollback;
    • observability with unit-tested alert rules;
    • the 19 ADRs.
  • Runbook (deploy/README.md): a new section on alert emails through an SMTP service, using Resend as the example. The API key is piped from the clipboard over SSH, so it never shows on screen.

Nothing changes in the code. Everything below "Tech stack" stays as it was.

The README still said in development and listed the features as planned. It now links
the live site, says what works, draws the architecture and lists the engineering
choices worth a look. The runbook explains alert emails through an SMTP service.
@sonarqubecloud

Copy link
Copy Markdown

@MCCProgrammer
MCCProgrammer merged commit 00c760a into main Oct 28, 2026
10 checks passed
@MCCProgrammer
MCCProgrammer deleted the docs/readme-showcase branch October 28, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant