SAAT-ClaudeCode/reference-projects at main · DavidROliverBA/SAAT-ClaudeCode · GitHub
Skip to content

Latest commit

 

History

History

reference-projects

Folders and files

README.md

SAAT Reference Architecture Projects

Comprehensive end-to-end walkthroughs demonstrating the complete SAAT workflow across three different domains.


📚 Available Walkthroughs

1. E-Commerce Platform - Brownfield Modernization

Scenario: Transform a failing monolithic PHP app into scalable microservices

  • Type: Brownfield (existing codebase)
  • Domain: E-commerce / Retail
  • Focus: Availability, Performance, Scalability
  • Compliance: PCI-DSS, GDPR
  • Timeline: 12 months
  • Complexity: ⭐⭐⭐⭐

You'll Learn:

  • Using saat-discover to analyze existing codebases
  • Strangler fig migration pattern
  • Active-active deployment strategies
  • E-commerce architecture characteristics
  • PCI-DSS payment processing compliance

Key Challenges:

  • Payment service single point of failure (CRITICAL)
  • Database scalability bottleneck
  • No caching layer (350ms → 100ms target)
  • Zero downtime migration

Start E-Commerce Walkthrough →


2. Microservices API Gateway - Greenfield Project

Scenario: Build a high-performance API gateway from requirements

  • Type: Greenfield (new project)
  • Domain: Enterprise SaaS Platform
  • Focus: Performance, Scalability, Security
  • Compliance: SOC 2
  • Timeline: 3 months
  • Complexity: ⭐⭐⭐

You'll Learn:

  • Using saat-requirements to extract structured requirements
  • Ultra-low latency architecture (<10ms p99)
  • Multi-cloud deployment (AWS + GCP)
  • API security patterns (OAuth 2.0, rate limiting)
  • Performance testing with k6

Key Challenges:

  • Sub-10ms latency requirement
  • 100,000 requests/second throughput
  • Multi-cloud portability
  • Blue-green deployment strategy

Start API Gateway Walkthrough →


3. Healthcare Patient Portal - HIPAA Compliance

Scenario: Build a HIPAA-compliant patient portal with EHR integration

  • Type: Hybrid (new portal + legacy integration)
  • Domain: Healthcare / Telemedicine
  • Focus: Security, Privacy, Auditability
  • Compliance: HIPAA, HITECH
  • Timeline: 9 months
  • Complexity: ⭐⭐⭐⭐⭐

You'll Learn:

  • HIPAA Security Rule compliance (164.308, 164.310, 164.312)
  • PHI protection strategies (encryption, access control)
  • Zero trust architecture for healthcare
  • Break-the-glass emergency access
  • HL7 FHIR EHR integration

Key Challenges:

  • Zero PHI breaches (non-negotiable)
  • 100% audit trail for all PHI access
  • EHR integration (Epic, Cerner)
  • Business Associate Agreements (BAAs)

Start Healthcare Walkthrough →


🎯 Workflow Comparison

Aspect E-Commerce API Gateway Healthcare
Type Brownfield Greenfield Hybrid
First Agent saat-discover saat-requirements saat-requirements + saat-discover
Primary Focus Scalability Performance Compliance
Complexity High Medium Very High
Compliance PCI-DSS SOC 2 HIPAA
Timeline 12 months 3 months 9 months
Best For Refactoring monoliths Building from scratch Regulated industries

🚀 Quick Start Guide

Choose Your Path

  1. New to SAAT? → Start with API Gateway

    • Greenfield is easier to understand
    • Focuses on one problem (performance)
    • Quickest to complete (3-4 hours)
  2. Need to modernize existing system? → Try E-Commerce

    • Real-world migration scenario
    • Learn discovery and analysis
    • Comprehensive architecture patterns
  3. Working in regulated industry? → Study Healthcare

    • HIPAA compliance deep dive
    • Security and audit patterns
    • Compliance-first architecture

📊 Learning Progression

Beginner Path (8-10 hours)

1. API Gateway Walkthrough (4 hours)
   ↓
2. Review SAAT Agents Guide (1 hour)
   ↓
3. Try Interactive Characteristics Generator (30 min)
   ↓
4. Explore Example Files (1 hour)

Intermediate Path (16-20 hours)

1. API Gateway (4 hours)
   ↓
2. E-Commerce Platform (6 hours)
   ↓
3. Compare brownfield vs. greenfield workflows (1 hour)
   ↓
4. Customize for your project (4 hours)

Advanced Path (24-30 hours)

1. All three walkthroughs (15 hours)
   ↓
2. Deploy to cloud (staging) (5 hours)
   ↓
3. Load/security testing (3 hours)
   ↓
4. Full compliance audit simulation (3 hours)

🎓 What You'll Master

Architecture Skills

  • ✅ C4 Modeling - Systems, Containers, Components, Relationships
  • ✅ Architecture Characteristics - 14 standard characteristics (Mark Richards)
  • ✅ Criticality Levels - CS1, CS2, SL1, SL2, STANDARD
  • ✅ Gap Analysis - Identify and prioritize improvements
  • ✅ Architecture Decision Records - Document key decisions

Technical Skills

  • ✅ Microservices Patterns - Service mesh, event-driven, CQRS
  • ✅ Cloud Architecture - AWS, GCP, multi-cloud
  • ✅ Infrastructure as Code - Terraform, multi-region
  • ✅ API Design - REST, GraphQL, gRPC
  • ✅ Security Patterns - Zero trust, encryption, audit

Compliance Skills

  • ✅ PCI-DSS - Payment card compliance
  • ✅ HIPAA - Healthcare data protection
  • ✅ GDPR - Data privacy regulations
  • ✅ SOC 2 - Security controls

SAAT Mastery

  • ✅ All 11 SAAT agents
  • ✅ Brownfield workflow (discover → modernize)
  • ✅ Greenfield workflow (requirements → design)
  • ✅ Compliance workflow (validate → audit)
  • ✅ Full pipeline orchestration

🛠️ Tools & Technologies Used

Across All Walkthroughs

Category Technologies
Languages Node.js, Python, Go, Java
Frontend React, Next.js, React Native
Backend Express, FastAPI, Spring Boot
Databases PostgreSQL, MongoDB, Redis
Cloud AWS, GCP, Azure
IaC Terraform, CloudFormation
Containers Docker, Kubernetes, EKS, GKE
Messaging SQS, EventBridge, Kafka, RabbitMQ
Monitoring Prometheus, Grafana, DataDog, CloudWatch
Security OAuth 2.0, JWT, mTLS, WAF, KMS

💡 Pro Tips

For Beginners

  1. Start simple - Don't try to customize on first pass
  2. Follow walkthrough exactly - Build understanding first
  3. Take notes - Document what you learn
  4. Ask questions - Open issues for clarification

For Practitioners

  1. Compare patterns - See how same problems solved differently
  2. Adapt to your context - Copy patterns, not implementations
  3. Focus on tradeoffs - Understand when to use each pattern
  4. Consider constraints - Budget, timeline, team skills

For Teams

  1. Walkthrough together - Pair/mob programming style
  2. Discuss decisions - Why this pattern vs. alternatives?
  3. Create your own - Build walkthrough for your domain
  4. Share learnings - Contribute back to community

📚 Additional Resources

Examples & Templates

Tools & Scripts

CI/CD Integration

Documentation


🤝 Contributing

Create Your Own Walkthrough

Have a unique architecture challenge? Create a reference walkthrough:

# 1. Copy template
cp -r reference-projects/microservices-gateway reference-projects/my-project

# 2. Update README.md
#    - Project overview
#    - Business context
#    - Architecture highlights

# 3. Create WALKTHROUGH.md
#    - Step-by-step SAAT workflow
#    - Agent invocations
#    - Key learnings

# 4. Add example files
#    - requirements.md or discovery.json
#    - characteristics.json
#    - architecture.json

# 5. Submit PR!

Improve Existing Walkthroughs

Found an issue or have suggestions?

  1. Open an issue describing the improvement
  2. Fork the repository
  3. Make your changes
  4. Submit a pull request

❓ FAQ

Q: Which walkthrough should I start with?

A: For most people, start with API Gateway (greenfield). It's the simplest and focuses on one problem area. If you're modernizing an existing system, start with E-Commerce (brownfield).

Q: Do I need to deploy these to cloud?

A: No, the walkthroughs are primarily learning exercises. You can follow along without deploying anything. However, deploying to a sandbox environment reinforces learning.

Q: Can I use these patterns in production?

A: The patterns and architecture are production-ready, but you should:

  • Adapt to your specific requirements
  • Conduct proper security audits
  • Perform load testing
  • Engage compliance experts (for regulated industries)

Q: How long does each walkthrough take?

A:

  • API Gateway: 3-4 hours
  • E-Commerce: 5-6 hours
  • Healthcare: 6-8 hours

Add 50% more time if deploying to cloud.

Q: Are the example JSON files realistic?

A: Yes! They're based on real-world projects and include realistic:

  • Architecture scores (not perfect!)
  • Gap analysis with actual effort estimates
  • Security findings with CVSS scores
  • Compliance gaps

Q: What if I work in a different domain?

A: The patterns are transferable:

  • Finance → Use Healthcare (similar compliance needs)
  • IoT → Use API Gateway (performance focus)
  • Media → Use E-Commerce (scalability focus)

Or create your own walkthrough following the templates!


📖 Next Steps

  1. Choose a walkthrough based on your needs
  2. Read the README to understand the scenario
  3. Follow the WALKTHROUGH.md step-by-step
  4. Review generated files (JSON, docs, Terraform)
  5. Adapt patterns to your project

🌟 Success Stories

Share your SAAT journey! Open an issue with:

  • Which walkthrough you completed
  • What you learned
  • How you applied it to your project

We'd love to hear from you!


Ready to start? Choose your walkthrough: