Software Engineering Done Right - The Micro-Frontend Adapter framework

A repository with examples of software engineered in the right way.

Security & Hardening

Pre-Commit Hooks

Git hooks automatically validate commits for:

• Secrets detection: Blocks hardcoded passwords, API keys, tokens, etc.

• Keystore protection: Prevents committing SSL keystores

• Workflow validation: Runs actionlint on modified GitHub Actions workflows

• Package lock consistency: Ensures lock files match manifest files

Setup hooks locally:

git config core.hooksPath .githooks
chmod +x .githooks/pre-commit .githooks/pre-push

See .githooks/README.md for detailed information.

Secrets Management

This repository enforces a zero-credentials policy - no secrets are stored in version control.

• Configuration: Use environment variable placeholders (e.g., ${DATABASE_PASSWORD})

• Local development: Copy .env.example to .env and add your credentials (.env is gitignored)

• Production: Use secret management services (AWS Secrets Manager, Azure Key Vault, etc.)

See ZERO_CREDENTIALS_POLICY.md and SECRETS_POLICY.md for details.

Contributing

See CONTRIBUTING.md for contribution guidelines, including:

• Conventional Commits format

• Pull request process

• Code standards

• Security reporting

Security

For security issues, see SECURITY.md for responsible disclosure guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.