⚑ SDLC Workflow Visualization - Quick Reference

Essential commands, architecture overview, and quick-start guide for developers

πŸ“ Location

🎯 Purpose

Visual representation of our Software Development Lifecycle (SDLC) showing:

πŸ€– Sub-Agents in the Workflow

Requirements Agent (Stage 2)

  • When: Planning & Documentation phase
  • Purpose: Creates and updates requirement documents
  • Location: .github/agents/requirements.agent.md
  • Updates: Requirements/*.md files

Implementation Summaries Agent (Stage 2)

  • When: Planning & Documentation phase
  • Purpose: Documents completed features, bug fixes, and system changes
  • Location: .github/agents/implementation-summaries.agent.md
  • Updates: Implementation Summaries/*.md files

Design System Agent (Stage 3)

  • When: Development phase
  • Purpose: Manages design tokens, mixins, and global styles
  • Location: .github/agents/design-system.agent.md
  • Updates: src/styles/*.scss and DESIGN_SYSTEM.md

Firestore Rules Agent (Stage 3)

  • When: Development phase
  • Purpose: Creates and updates Firestore security rules
  • Location: .github/agents/firestore-rules.agent.md
  • Updates: firestore.rules

Migration Scripts Agent (Stage 3)

  • When: Development phase (data model changes)
  • Purpose: Creates data migration scripts for schema changes
  • Location: .github/agents/migration-scripts.agent.md
  • Updates: scripts/*.ts migration files

Online Help Agent (Stage 6)

  • When: Help Documentation phase
  • Purpose: Creates and updates online help documentation
  • Location: .github/agents/online-help.agent.md
  • Updates: src/assets/help/*.md files

GitHub Pages SDLC Agent (Stage 8)

  • When: Pull Request / Documentation phase
  • Purpose: Updates SDLC workflow visualization and GitHub Pages
  • Location: .github/agents/github-pages.agent.md
  • Updates: docs/*.html and docs/*.md files

GitHub Workflows Agent (Stage 9)

  • When: CI/CD Pipeline phase
  • Purpose: Creates and updates GitHub Actions workflows
  • Location: .github/agents/github-workflows.agent.md
  • Updates: .github/workflows/*.yml files

πŸ“Š The 10 Stages

1
Issue Creation
2
Planning & Docs
3
Development
4
Testing
5
E2E Testing
6
Help Docs
7
Code Review
8
Pull Request
9
CI/CD Pipeline
10
Production

Stage Details

  1. Issue Creation - GitHub Issues
  2. Planning & Documentation - Requirements Agent πŸ€–, Implementation Summaries Agent πŸ€–
  3. Development - Angular, Firebase, TypeScript; Design System Agent πŸ€–, Firestore Rules Agent πŸ€–, Migration Scripts Agent πŸ€–
  4. Testing & Validation - npm build, emulators
  5. E2E Testing - Playwright, automated tests
  6. Help Documentation - Online Help Agent πŸ€–
  7. Code Review - Automated tools, codeql_checker
  8. Pull Request - GitHub PR; GitHub Pages SDLC Agent πŸ€–
  9. CI/CD Pipeline - GitHub Actions; GitHub Workflows Agent πŸ€–
  10. Production Deployment - Firebase Hosting

πŸ’» Most Common Commands

Start Development Server
npm start

Starts Angular dev server on port 4200

Start Firebase Emulators
npm run emulator

Runs Firebase emulators locally

Development Mode
npm run dev

Runs both emulators and dev server

Build for Production
npm run build:prod

Creates optimized production build

Deploy to Firebase
npm run deploy

Builds and deploys to Firebase Hosting

Docker Development
npm run docker:dev

Runs app in Docker containers

🎨 Visual Design

πŸ“± Features

πŸ”§ Maintenance

To Update the Workflow:

  1. Edit docs/index.html
  2. Test locally: cd docs && python -m http.server 8000
  3. Commit and push to main branch
  4. GitHub Pages auto-deploys within 2 minutes

To Add New Stage:

  1. Copy an existing stage section in docs/index.html
  2. Update stage number, title, description, and tools
  3. Adjust arrow placement if needed
  4. Test locally before committing

To Modify Sub-Agent Information:

  1. Update the agent badge and description in the relevant stage
  2. Ensure consistency with .github/agents/*.agent.md files
  3. Test visual appearance

πŸ’‘ Use Cases

🎨 Most Used Design Tokens

/* Colors */ $color-primary: #667eea; $color-secondary: #764ba2; $color-success: #48bb78; $color-warning: #ed8936; $color-error: #f56565; /* Spacing */ $spacing-base: 1rem; $spacing-small: 0.5rem; $spacing-large: 2rem; /* Typography */ $font-size-base: 1rem; $font-size-large: 1.5rem; $font-size-small: 0.875rem;

πŸ“ž Questions?

See the full README in docs/README.md or the setup guide in docs/GITHUB_PAGES_SETUP.md

↑