PropelIQ

AI-driven velocity from idea to deploy

An enterprise-grade framework that combines Claude Code, specialized AI agents, and proven templates to accelerate high-quality software development across multiple technology stacks.

Why Choose PropelIQ?

From idea to production in minutes, not hours:

Traditional Development	PropelIQ	Time Saved
Manual project setup	`/generate-task` + `/execute-task`	60%
Writing test plans	`/generate-automation-test`	50%
Code reviews	`/review-pr` with AI analysis	60%
Requirements analysis	`/analyze-codebase` + `/generate-requirements`	50%

Core Value Propositions

Rapid Prototyping - Go from user story to working prototype in few hours
Intelligent Analysis - Deep codebase understanding with C4 architecture diagrams
Test-First Development - Automated Playwright test generation from requirements
Production Ready - Enterprise patterns with SOLID principles and security best practices
AI-Enhanced Workflows - 5 specialized agents for targeted development assistance

Prerequisites

Required Tools

Claude Code: Latest version (https://www.anthropic.com/claude-code)
Git: Version 2.25 or higher

Technology-Specific Requirements

Node.js: Version 18.x or higher

Optional Tools

Azure CLI: For Azure DevOps integration (if using azops commands)
GitHub CLI: For GitHub integration (if using gitops commands)
VS Code or Cursor: Optional IDEs for integration with Claude Code

Claude Code Security Configuration

This PropelIQ uses Claude Code security hooks to restrict access to sensitive files and prevent accidental exposure of production data.

Setup Instructions

Create or update your .claude/settings.local.json file with the following configuration:

{
  "hooks": {
    "PreToolUse": [{
      "matcher": "Read|Write|Edit|MultiEdit",
      "hooks": [{
        "type": "command",
        "command": "python .claude/hooks/file-access-validator.py"
      }]
    }]
  }
}

The hooks will automatically validate file access based on patterns defined in .claude/hooks/restricted-patterns.json
You can customize the restricted patterns by editing .claude/hooks/restricted-patterns.json to match your security requirements.

Note: .claude/settings.local.json is gitignored and will not be committed to the repository. This ensures your personal security configurations remain private while allowing team collaboration.

Architecture

PropelIQ Structure

PropelIQ/
├── .claude/                    # Claude Code configuration
│   ├── agents/                 # AI agents (5 specialized agents)
│   │   ├── code-analyzer.md
│   │   ├── design-analyzer.md
│   │   ├── mvp-builder.md
│   │   ├── pr-code-reviewer.md
│   │   └── task-analyzer.md
│   ├── commands/               # Custom commands
│   │   ├── azops/              # Azure DevOps commands
│   │   ├── design/             # Design generation commands
│   │   ├── discovery/          # Analysis & requirements commands
│   │   ├── gitops/             # GitHub operations commands
│   │   ├── task/               # Task management commands
│   │   ├── test/               # Test generation commands
│   │   └── ux/                 # UI/UX review commands
│   ├── hooks/                  # Security hooks
│   │   ├── file-access-validator.py
│   │   └── restricted-patterns.json
│   ├── CLAUDE.md               # Development guidelines
│   ├── settings.json           # Claude Code settings
│   └── settings.local.json     # Local settings (gitignored)
├── .propel/                    # Best practices library
│   ├── build/                  # Technology configurations
│   ├── context/                # Generated project artifacts
│   │   ├── docs/               # Documentation files
│   │   │   ├── spec.md         # Generated requirements with epics
│   │   │   ├── design.md       # System design documents
│   │   │   └── codeanalysis.md # Codebase analysis results
│   │   ├── figma/              # Design references
│   │   ├── tasks/              # Generated task plans and user stories
│   │   │   ├── us_001/         # User story folder
│   │   │   │   ├── us_001.md   # User story document
│   │   │   │   ├── task_001_*.md  # Implementation tasks
│   │   │   │   └── task_002_*.md  # More tasks for this story
│   │   │   ├── us_002/         # Additional user story folder
│   │   │   └── task_001_*.md   # General tasks (non-story)
│   │   └── tests/              # Generated test workflows
│   ├── gotchas/                # Best practices (15+ docs)
│   ├── media/                  # Images and diagrams
│   ├── templates/              # Output templates
│   │   ├── analyze_code_base.md
│   │   ├── analyze_task_base.md
│   │   ├── automation_test_base.md
│   │   ├── design_base.md
│   │   ├── design_reference_base.md
│   │   ├── requirement_base.md
│   │   ├── task_base.md
│   │   ├── triage_base.md
│   │   └── userstory-base.md
│   └── CLAUDE.md               # Command development guidelines
├── .env                        # Environment variables (gitignored)
├── .env.example                # Environment variables template
├── .gitattributes              # Git export attributes for template
├── .gitignore                  # Git ignore rules
├── .mcp.json                   # MCP server configuration
├── LICENSE                     # MIT License
└── README.md                   # This file

Note: The following directories are generated during command execution:
├── test-automation/            # Generated by /generate-playwright-scripts
│   ├── tests/                  # Executable Playwright test files
│   ├── pages/                  # Page Object Model classes
│   ├── data/                   # Test data and fixtures
│   └── utils/                  # Test utilities and helpers
└── mvp/                        # Generated by @mvp-builder agent

Key Directories

.claude/ - Claude Code configuration and AI agents

Directory	Purpose	Key Files
`agents/`	5 specialized AI agents	code-analyzer, design-analyzer, mvp-builder, pr-code-reviewer, task-analyzer
`commands/`	Custom Claude Code commands	discovery/, task/, design/, test/, gitops/, ux/
`CLAUDE.md`	Development context	Additional instructions for command development

.propel/context/ - Generated analysis and specifications

File/Folder	Generated By	Contains
`docs/codeanalysis.md`	`/analyze-codebase`	Architecture diagrams, security analysis, technical debt
`docs/spec.md`	`/generate-requirements`	Epics with mapped requirements, business context
`tasks/us_XXX/us_XXX.md`	`/generate-userstory`	Individual user stories with acceptance criteria
`tasks/us_XXX/task_*.md`	`/generate-task`	Implementation tasks organized by user story
`tasks/task_*.md`	`/generate-task`	General tasks (non-user story)
`test/`	`/generate-automation-test`	Test workflow specifications

.propel/ - Best practices and configuration library

Directory	Purpose	Coverage
`build/`	Technology configurations	React, .NET, Python, Node.js setups
`gotchas/`	Comprehensive best practices	15+ documentation files covering all aspects
`templates/`	Structured output templates	Analysis reports • Requirements • Design • Tasks • Tests
`media/`	Images and diagrams	Architecture diagrams, flow diagrams, screenshots

Enhanced Workflow Benefits

Epic → User Story → Task Hierarchy

PropelIQ's structured approach delivers measurable improvements:

Traditional Approach	PropelIQ Approach	Improvement
Manual requirement analysis	Auto-generated epics with mapped requirements	50% faster requirement processing
Ad-hoc user story creation	Structured us_XXX stories with acceptance criteria	60% better story quality and consistency
Scattered task management	Organized us_XXX/task_*.md hierarchy	60% better traceability and organization
Reactive quality assurance	Built-in INVEST principles and story validation	30% fewer requirement changes during development

Key Workflow Advantages

1. Automatic Story Generation

Epic-driven: Stories generated from epics with proper requirement mapping
INVEST Compliance: All stories follow Independent, Negotiable, Valuable, Estimable, Small, Testable principles
Effort Estimation: Automatic story point calculation (1 point = 6 hours) with breakdown for large stories

2. Hierarchical Organization

Clear Traceability: Epic → User Story → Task → Implementation
Folder Structure: .propel/context/tasks/us_XXX/ organization for easy navigation
Sequential IDs: Consistent us_001, us_002, task_001, task_002 numbering

3. Quality Assurance Integration

Template Compliance: All outputs follow userstory-base.md and task_base.md templates
Validation Gates: Built-in quality checks at each level
Acceptance Criteria: Given/When/Then format for all user stories

4. Flexible Story Management

Selective Generation: Generate stories for specific epics or entire scope files
Manual Override: Use /generate-userstory for additional story creation
Multi-input Support: Accept scope files, epic IDs, URLs, or direct text

Supported Technology Stacks

Stack	Framework/Version	Features	Best Practices Doc
Frontend	React 19 + TypeScript + Vite	CSS Modules, Jest, ESLint	React Gotchas
Backend	.NET 8 + ASP.NET Core	Clean Architecture, EF Core, xUnit	.NET Gotchas
API	Python FastAPI	Async patterns, Pydantic, pytest	Backend Best Practices
Web	Python Django	ORM, Admin, Testing	Backend Best Practices
Server	Node.js Express + TypeScript	RESTful APIs, Middleware	Backend Best Practices
SPA	Angular + CLI	Components, Services, Guards	Frontend Best Practices
Progressive	Vue 3 + Composition API	Reactive, Composables	Frontend Best Practices
Cloud	GoLang + Gin/Echo	High performance, Microservices	General Coding Standards
Enterprise	Java Spring Boot	Enterprise patterns, JPA	General Coding Standards

Comprehensive Coverage: Each stack is supported by extensive documentation in .propel/gotchas/ covering architecture patterns, security, performance, and testing strategies.

How PropelIQ Works

The power of AI-driven development automation in 4 simple steps:

🔄 Core Workflow Components

Component	Role	Example
Commands	Entry points for all operations	`/analyze-codebase`, `/generate-task`, `/execute-task`
Specialized Agents	Domain-specific AI processing	Code analysis, task planning, code review, quick prototype
Templates	Consistent output structure	Requirements, designs, test plans, analysis reports
Best Practices	Quality assurance & standards	SOLID principles, security patterns, anti-patterns
MCP Servers	External integrations	Context7, Playwright, GitHub, Azure DevOps

Real-World Example: From User Story to Running Tests

# 1. Start with a user story
echo "Develop a web based onboarding digital platform that supports registration, renewal, and lifecycle management of institutional and
individual memberships. The goal is to simplify the user experience, streamline internal workflows, and enable process automation across membership types and levels." > scope.md

# 2. Generate structured requirements with epics
/generate-requirements scope.md
# → Creates .propel/context/docs/spec.md with epics and acceptance criteria

# 3. Generate user stories from epics
/generate-userstory
# → Creates .propel/context/tasks/us_XXX/us_XXX.md for all epics

# 3a. (Optional) Generate user stories for specific epic
/generate-userstory EP-001
# → Creates .propel/context/tasks/us_XXX/us_XXX.md for EP-001

# 4. Break down user stories into executable tasks
/generate-task .propel/context/tasks/us_001/us_001.md
# → Creates .propel/context/tasks/us_001/task_001_*.md

# 5. Generate comprehensive tests
/generate-automation-test .propel/context/tasks/us_001/us_001.md
# → Creates .propel/context/test/us_001_test_workflow.md

# 6. Convert to executable Playwright scripts
/generate-playwright-scripts
# → Creates test-automation/tests/us_001_*.spec.ts with Page Objects

# 7. Execute the task
/execute-task .propel/context/tasks/us_001/task_001_*.md
# → Implements the task with TodoWrite tracking

# Total time: 5-10 minutes vs 2-4 hours manually

Quality Assurance Built-In

Every generated artifact automatically includes:

Security Best Practices - OWASP Top 10 compliance, input validation
Performance Patterns - Caching strategies, optimization techniques
Test Coverage - Unit, integration, and E2E test generation
Documentation - Code comments, API docs, architecture diagrams
Code Review - Automated quality checks and validation

Specialized Agents

PropelIQ includes 5 AI agents that provide targeted expertise for different aspects of software development:

Agent	Purpose	When to Use	Key Capabilities
Code Analyzer	Deep codebase analysis	Legacy code, technical debt, architecture review	C4 diagrams, security analysis, dependency mapping
PR Code Reviewer	Comprehensive code review	Pull requests, quality assurance	SOLID principles, vulnerability detection, compliance
Design Analyzer	Architecture & design patterns	System design, modernization	Pattern recommendations, scalability assessment
MVP Builder	General rapid prototyping	Proof of concepts, standard prototyping	Quick prototyping, shadcn UI, lean validation
Task Analyzer	Post-implementation quality review	Quality assurance	Detec task implementation, gate review

Agent Integration Patterns

# Agent invocation through commands
/analyze-codebase # → internally call agent=code-analyzer 
/generate-design # → internally call agent=design-analyzer
/review-pr # → internally call agent=pr-code-reviewer
/analyze-task # → internally call agent=task-analyzer

# Direct agent invocation
@mvp-builder "Scope Description"
@mvp-builder scope-document.md

Quick Start

1. Get PropelIQ Framework

Option 1: Direct Clone

git clone <repository-url>
cd "PropelIQ"

Option 2: Use GitHub Template (Recommended)

Visit the PropelIQ GitHub repository
Click "Use this template" button
Name your new repository

Clone your new repository:

git clone <your-new-repo-url>
cd <your-project-name>

2. Install MCP Servers

Environment Variables Setup (Required):

Set these environment variables before installing MCP servers:

# Required for Context7 (documentation lookup)
export CONTEXT7_API_KEY="your-context7-api-key"

# Required for GitHub integration
export GITHUB_PAT="your-github-personal-access-token"

# Required for Azure DevOps integration
export AZ_DEVOPS_ORG="your-azure-devops-organization"

Complete MCP Server Setup:

# Core MCP servers (Required)
claude mcp add context7 http https://mcp.context7.com/mcp --header "CONTEXT7_API_KEY=${CONTEXT7_API_KEY}" --scope project
claude mcp add sequential-thinking stdio npx @modelcontextprotocol/server-sequential-thinking --scope project

# Development & Testing
claude mcp add playwright stdio npx @playwright/mcp@latest --scope project

# Platform Integrations (Choose based on your needs)
claude mcp add github stdio npx -y @modelcontextprotocol/server-github@latest --env "GITHUB_PERSONAL_ACCESS_TOKEN=${GITHUB_PAT}" --scope project
claude mcp add azure-devops stdio npx -y @azure-devops/mcp ${AZ_DEVOPS_ORG} --scope project

# UI Development (Required for MVP Builder)
claude mcp add shadcn stdio npx shadcn@latest mcp --scope project

MCP Server Requirements by Use Case:

Use Case	Required MCP Servers	Purpose
Basic Development	Context7, sequential-thinking	Core framework functionality
Test Automation	+ Playwright	Automated testing capabilities
GitHub Integration	+ GitHub	Pull request reviews, repository operations
Azure DevOps	+ Azure DevOps	Azure DevOps integration
MVP Development	+ shadcn	UI component generation with shadcn
Complete Setup	All of the above	Full framework capabilities

After installation, restart Claude Code or reload the configuration to activate the MCP servers.

3. Try Your First Command

Get started in under 2 minutes:

# Analyze an existing project by running the command from the root folder of the existing source code
/analyze-codebase
# → Generates comprehensive analysis in .propel/context/docs/codeanalysis.md

# Create user story for business needs
/generate-requirements [BRD file | Plain text]
# → Generates comprehensive user stories in .propel/context/docs/spec.md

Success indicators:

New files appear in .propel/context/ folder
Commands complete without errors
Generated content follows framework templates

📋 Commands & Workflows

🔄 Common Development Workflows

Which workflow should you use?

Green-field Development - Building from scratch

# 1. Create requirements with epics
/generate-requirements brd.md
# → .propel/context/docs/spec.md (with epics)

# 2. Generate user stories from epics
/generate-userstory
# → .propel/context/tasks/us_XXX/us_XXX.md (all epics)

# 2a. Or generate stories for specific epic (optional)
/generate-userstory EP-001
# → .propel/context/tasks/us_XXX/us_XXX.md (specific epic)

# 3. Generate system design (optional)
/generate-design .propel/context/docs/spec.md
# → .propel/context/docs/design.md

# 4. Break down user stories into implementation tasks
/generate-task .propel/context/tasks/us_001/us_001.md
# → .propel/context/tasks/us_001/task_001_implement_feature.md

# 5. Execute tasks systematically for code generation
/execute-task .propel/context/tasks/us_001/task_001_implement_feature.md
# → Logic Implementation with TodoWrite tracking

# 6. Quality review (optional)
/analyze-task .propel/context/tasks/us_001/task_001_implement_feature.md
# → Quality assessment and recommendations for the implemented logic

Brown-field Development - Working with existing code

# 1. Understand the codebase
/analyze-codebase <repo url path | code-base directory | root-path>
# → .propel/context/docs/codeanalysis.md

# 2. Generate requirements with epics
/generate-requirements new-feature-spec.md
# → .propel/context/docs/spec.md (with epics)

# 3. Generate user stories from epics
/generate-userstory
# → .propel/context/tasks/us_XXX/us_XXX.md (all epics)

# 3a. Or generate stories for specific epic (optional)
/generate-userstory EP-002
# → .propel/context/tasks/us_XXX/us_XXX.md (specific epic)

# 4. Break down user stories into implementation tasks
/generate-task .propel/context/tasks/us_005/us_005.md
# → .propel/context/tasks/us_005/task_001_integrate_feature.md

# 5. Execute with existing code integration
/execute-task .propel/context/tasks/us_005/task_001_integrate_feature.md
# → Updated codebase with new functionality

Test-Driven Development - Tests first approach

# 1. Generate comprehensive test workflows
/generate-automation-test .propel/context/docs/spec.md
# → .propel/context/test/test_workflow_*.md

# 2. Create executable Playwright scripts
/generate-playwright-scripts
# → test-automation/tests/, pages/, data/, utils/

# 3. Implement features to pass tests
/execute-task .propel/context/tasks/feature.md
# → Implementation guided by tests

Bug-fixing Workflow - Systematic issue resolution

# 1. Triage bug and create fix task with root cause analysis
/generate-bugfix-task "Bug: Login fails with 500 error on special characters | bug url"
# → Performs comprehensive triage protocol
# → Identifies root cause and impact
# → .propel/context/tasks/task_001_fix_login_special_chars.md

# 2. Execute the generated fix task
/execute-task .propel/context/tasks/task_001_fix_login_special_chars.md
# → Implements fix with regression prevention
# → Guided debugging with TodoWrite tracking

# 3. Verify fix completeness and quality
/analyze-task .propel/context/tasks/task_001_fix_login_special_chars.md
# → Validates bug resolution and test coverage
# → Ensures no regression introduced

MVP Validation - Validate business hypotheses rapidly

# Direct agent invocation for MVP development (requires @mvp-builder)
@agent-mvp-builder "Build a prototype automated invoice tracking"

# Alternative: Provide scope document
@agent-mvp-builder scope-of-work.md

Code Review & Quality - Maintain high quality standards

# Review pull requests
/review-pr [pr-url-or-number | local changes]
# → .propel/context/reviews/review-pr.md with comprehensive analysis

# Resolve specific review comments
/resolve-review-comment [comment-reference]
# → Implements the corrections to resolve the comment.

# UI/UX review with visual testing
/review-user-interface [ui-spec-or-screenshot]
# → Playwright/snapshot.jpg

Command Reference

Command	Purpose	Input	Output
`/analyze-codebase`	Deep codebase analysis	Repository path/URL	`.propel/context/docs/codeanalysis.md`
`/generate-requirements`	Create structured requirements	Specifications, user stories	`.propel/context/docs/spec.md` with epics
`/generate-userstory`	Generate user stories from epics	Epic ID, scope file, or text	`.propel/context/tasks/us_XXX/us_XXX.md`
`/generate-design`	System design & architecture	Requirements, specifications	`.propel/context/docs/design.md`
`/generate-task`	Break down into executable tasks	User stories, requirements	`.propel/context/tasks/us_XXX/task_.md` or `.propel/context/tasks/task_.md`
`/execute-task`	Implement tasks systematically	Task file path	Technology-specific code
`/analyze-task`	Post-implementation quality review	Task file path	Quality assessment report
`/generate-automation-test`	Create test workflows	Requirements, use cases	`.propel/context/test/workflow_*.md`
`/generate-playwright-scripts`	Convert to executable tests	Workflow files	`test-automation/` structure
`/review-pr`	Comprehensive PR analysis	PR URL/number	`.propel/context/reviews/review-pr.md`
`/resolve-review-comment`	Address review feedback	Comment reference	Resolution documentation
`/review-user-interface`	UI/UX analysis	UI specs, screenshots	`.propel/context/reviews/ui-review.md`
`@agent-mvp-builder`	Rapid MVP for hypothesis testing	Business hypothesis or scope doc	`mvp/` folder with working code

MCP Server Configuration

MCP servers are configured project-wide in the root .mcp.json file. This configuration enables seamless integration with external tools and services.

Complete .mcp.json Configuration:

{
  "mcpServers": {
    "context7": {
      "type": "http",
      "url": "https://mcp.context7.com/mcp",
      "headers": {
        "CONTEXT7_API_KEY": "${CONTEXT7_API_KEY}"
      }
    },
    "playwright": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "@playwright/mcp@latest"
      ],
      "env": {}
    },
    "sequential-thinking": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "@modelcontextprotocol/server-sequential-thinking"
      ],
      "env": {}
    },
    "azure-devops": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@azure-devops/mcp",
        "${AZ_DEVOPS_ORG}"
      ],
      "env": {}
    },
    "shadcn": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "shadcn@latest",
        "mcp"
      ],
      "env": {}
    },
    "github": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-github@latest",
        "--env",
        "GITHUB_PERSONAL_ACCESS_TOKEN=${GITHUB_PAT}"
      ],
      "env": {}
    }
  }
}

Complete .env Configuration:

# Core APIs
CONTEXT7_API_KEY=your-context7-api-key-here

# Platform Integration
GITHUB_PAT=your-github-personal-access-token
AZ_DEVOPS_ORG=your-azure-devops-organization

Security:
The .env file is listed in .gitignore and should never be committed to the repository.

Setup Steps:

Copy .mcp.json from the repository root.
Create a .env file in the root and add your API keys.
Run claude mcp list or /mcp to verify MCP server setup.
Run /agent to verify the available agents.
Use @ (e.g. @agent-mvp-builder) to run the agents directly

Quality Standards

Built-in enterprise-grade quality assurance:

Metrics & Standards

Maximum 500 lines per source file for maintainability
80% minimum test coverage across all application layers
SOLID principles compliance with automated validation
Comprehensive documentation for all public APIs and components
Security-first approach with OWASP Top 10 compliance

Validation Commands

# Universal quality checks built into all generated code
npm run lint && npm test && npm build        # React/Node.js
dotnet format && dotnet test && dotnet build # .NET
pytest --cov=src tests/ --cov-report=term   # Python

Built-in Protections

Anti-pattern detection and prevention across all technology stacks
Performance optimization patterns applied automatically
Security vulnerability scanning and remediation suggestions
Database optimization with query analysis and indexing recommendations
DevOps best practices integration for CI/CD pipelines

Frequently Asked Questions

Getting Started

Q: Do I need Claude Code to use PropelIQ? A: Yes, PropelIQ is specifically designed for Claude Code and requires it to function.

Q: Which MCP servers do I need?
A: Basic: Context7 + sequential-thinking. Testing: Add Playwright. Azure: Add Azure DevOps MCP.

Q: Can I use this with existing projects?
A: Absolutely! Use the brown-field workflow starting with /analyze-codebase.

Development

Q: Which technology stacks are fully supported?
A: It support most of the technology stack.

Q: Can I add custom commands?
A: Yes! Follow patterns in .claude/commands/.

Performance

Q: How much time does this save?
A: 70-80% reduction in setup time, 60% faster code reviews, 75% faster requirements analysis.

Q: What's the learning curve? A: 2 minutes to first command, 30 minutes to productive workflows, 1 hour for advanced features.

Epics, User Stories & Tasks

Q: What's the difference between epics, user stories, and tasks? A: Epics are high-level features mapped to requirements. User Stories (us_XXX) break epics into user-focused deliverables. Tasks break stories into 4-hour implementation units.

Contributing

Development Workflow

Follow existing patterns in the codebase
Reference .propel/gotchas/ for technology-specific guidance
Use validation commands before committing
Ensure comprehensive test coverage

Adding New Technology Stacks

Create configuration in .propel/build/
Add best practices to .propel/gotchas/
Update validation commands
Include example implementations

Custom Command Development

Follow patterns in .claude/commands/
Commands are defined as Markdown files with specific structure
Include comprehensive documentation and usage examples
Ensure quality validation integration

Agent Development

Create agent using /agent --> create new agent in the Claude code.
Define agent purpose, capabilities, and integration points
Include clear usage guidelines and examples
Ensure agents work seamlessly
Test agent functionality across different scenarios
Agents are defined as Markdown files with specific structure in .claude/agents/
Ensure quality validation integration

Documentation & Resources

By User Journey

Getting Started [New Users]

Document	Purpose
README.md	Complete PropelIQ overview
.propel/gotchas/framework_methodology.md	Usage patterns and workflows
.propel/gotchas/troubleshooting_guide.md	Common setup issues and solutions

Development Reference [Active Development]

Category	Document	Purpose
Commands	`.claude/commands/*/`	All command implementations
Templates	`.propel/templates/*.md`	Output structure templates
Generated	`.propel/context/*.md`	Your project analysis and specs

Best Practices [Quality Assurance]

Focus Area	Document
Architecture	architecture_patterns.md • design-principles.md
Quality	anti_patterns.md • validation_commands.md
Frontend	frontend_best_practices.md • react_gotchas.md
Backend	backend_best_practices.md • dotnet_gotchas.md
Database	database_best_practices.md
DevOps	devops_best_practices.md
Testing	automation_testing_gotchas.md • testing_workflow_patterns.md
Standards	general_coding_standards.md • anti_redundancy_rules.md

Advanced Configuration [Power Users]

Component	Configuration
AI Agents	`.claude/agents/*.md` - 6 specialized agents (including MVP Builder)
MCP Setup	`.mcp.json` - Server integrations

Examples & Use Cases

E-commerce Platform (Brown-field)

# 1. Analyze codebase for insights
/analyze-codebase https://github.com/competitor/shop

# 2. Generate epics from requirements
/generate-requirements "Multi-vendor shopping cart with payment integration"
# → .propel/context/docs/spec.md (with epics)

# 3. Generate user stories from epics
/generate-userstory
# → .propel/context/tasks/us_XXX/us_XXX.md (all epics)

# 3a. Or generate stories for specific features (optional)
/generate-userstory EP-001
# → .propel/context/tasks/us_XXX/us_XXX.md (specific epic)

# 4. Create comprehensive test suite
/generate-automation-test .propel/context/docs/spec.md
/generate-playwright-scripts

# 5. Break down user stories into implementation tasks
/generate-task .propel/context/tasks/us_003/us_003.md
# → .propel/context/tasks/us_003/task_001_implement_cart.md

# 6. Implement with best practices
/execute-task .propel/context/tasks/us_003/task_001_implement_cart.md

Enterprise Dashboard (Green-field)

# 1. Quick prototype for client validation
@mvp-builder "Real-time analytics dashboard with role-based access for client validation" or <scope document>
# → mvp/ folder with working prototype for stakeholder feedback

# 2. Generate epics from requirements
/generate-requirements "Real-time analytics dashboard with role-based access"
# → .propel/context/docs/spec.md (with epics)

# 2a. Generate user stories from epics
/generate-userstory
# → .propel/context/tasks/us_XXX/us_XXX.md (all epics)

# 3. Design system architecture
/generate-design .propel/context/docs/spec.md

# 4. Break down user stories into implementation tasks
/generate-task .propel/context/tasks/us_001/us_001.md
# → .propel/context/tasks/us_001/task_001_implement_dashboard.md

# 5. Generate secure, scalable implementation
/execute-task .propel/context/tasks/us_001/task_001_implement_dashboard.md

App Modernization (Legacy to Modern)

# 1. Analyze existing codebase for insights (reverse-engineering)
/analyze-codebase https://github.com/legacy-app/monolith
# → .propel/context/docs/codeanalysis.md with C4 diagrams, technical debt, security analysis

# 2. Generate epics for modernization
/generate-requirements "Modernize legacy monolith to microservices with API-first architecture"
# → .propel/context/docs/spec.md with modernization epics

# 3. Generate user stories from modernization epics
/generate-userstory
# → .propel/context/tasks/us_XXX/us_XXX.md (all modernization epics)

# 3a. Or generate stories for specific modernization phases (optional)
/generate-userstory EP-002
# → .propel/context/tasks/us_XXX/us_XXX.md (specific epic)

# 4. Generate system architecture
/generate-design .propel/context/docs/spec.md
# → .propel/context/docs/design.md with modernized system architecture and migration strategy

# 5. Create comprehensive test suite
/generate-automation-test .propel/context/docs/spec.md
/generate-playwright-scripts
# → .propel/context/test/workflow_*.md and test-automation/ with migration validation tests

# 6. Break down modernization stories into implementation tasks
/generate-task .propel/context/tasks/us_005/us_005.md
# → .propel/context/tasks/us_005/task_001_modernize_auth.md (phased implementation tasks)

# 7. Generate secure, scalable implementation
/execute-task .propel/context/tasks/us_005/task_001_modernize_auth.md
# → Modern microservices implementation with security best practices

Contributing

How to Contribute

Fork the repository and create a feature branch
Follow existing patterns in .claude/commands/ and .propel/
Test your changes with the validation commands
Update documentation and add examples
Submit a pull request with clear description

Development Guidelines

Commands or agents are Markdown files with specific structure. Refer to Claude code documentation for further details.
Templates ensure consistent output format
Best practices prevent common pitfalls
All contributions must include comprehensive documentation

Built for developers who value quality, speed, and intelligent automation.

Name		Name	Last commit message	Last commit date
Latest commit History 125 Commits
.claude		.claude
.propel		.propel
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
.mcp.json		.mcp.json
LICENSE		LICENSE
README.md		README.md

License

kanini/PropelIQ_ESGR

Folders and files

Latest commit

History

Repository files navigation

PropelIQ

Table of Contents

Getting Started

Development

Resources

Why Choose PropelIQ?

Core Value Propositions

Prerequisites

Required Tools

Technology-Specific Requirements

Optional Tools

Claude Code Security Configuration

Setup Instructions

Architecture

PropelIQ Structure

Key Directories

Enhanced Workflow Benefits

Epic → User Story → Task Hierarchy

Key Workflow Advantages

Supported Technology Stacks

How PropelIQ Works

🔄 Core Workflow Components

Real-World Example: From User Story to Running Tests

Quality Assurance Built-In

Specialized Agents

Agent Integration Patterns

Quick Start

1. Get PropelIQ Framework

2. Install MCP Servers

3. Try Your First Command

📋 Commands & Workflows

🔄 Common Development Workflows

Command Reference

MCP Server Configuration

Quality Standards

Metrics & Standards

Validation Commands

Built-in Protections

Frequently Asked Questions

Contributing

Development Workflow

Adding New Technology Stacks

Custom Command Development

Agent Development

Documentation & Resources

By User Journey

Examples & Use Cases

E-commerce Platform (Brown-field)

Enterprise Dashboard (Green-field)

App Modernization (Legacy to Modern)

Contributing

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Packages