Skip to content

PROJECT_TEMPLATE.md

Latest commit

 

History

History
217 lines (175 loc) · 7.86 KB

PROJECT_TEMPLATE.md

File metadata and controls

217 lines (175 loc) · 7.86 KB

Universal Project Template

This file will be customized for each specific project created from the template.

🎯 Template Overview

This is the Universal App Development Template that provides enterprise-grade development workflows for any type of application. When you create a new project, this file gets customized with project-specific information.

🚀 Template Features

Automatic Quality Assurance

  • >95% Test Coverage enforced automatically
  • Comprehensive Security Validation built-in
  • Performance Benchmarking with automated monitoring
  • Documentation Updates that never fall behind code
  • Code Quality Enforcement via automated tools

Universal Application Support

  • Web Applications: Flask, FastAPI, Django
  • CLI Applications: Click-based command-line tools
  • Microservices: Containerized services with observability
  • Data Processing: ETL pipelines and analytics
  • Desktop Applications: Electron, Tauri, PyQt
  • Mobile Applications: React Native, Flutter

LLM-Optimized Development

  • Automatic Workflow Triggering for any development request
  • Intelligent Code Generation following established patterns
  • Comprehensive Testing created automatically
  • Documentation Synchronization maintained automatically
  • Security Best Practices applied by default

📋 How to Use This Template

1. Create New Project

# Copy template to new project
cp -r AppDevelopmentTemplate/ MyNewApp/
cd MyNewApp/

# Customize for your project type
python scripts/setup_new_project.py --name="MyApp" --type="web" --framework="flask"

2. Install Development System

# Install all automation and validation
python scripts/install_dev_system.py

# Verify everything is working
python scripts/validate_project_setup.py

3. Start Development

# Make your first LLM request:
# "FEATURE: Create basic application structure
# Follow project guidelines and update all relevant documentation."

🎭 Template Customization

When you run the setup script, this template transforms into a project-specific guide with:

Project Information

  • Name: Your chosen project name
  • Type: web, cli, microservice, data, desktop, mobile
  • Framework: Specific framework (Flask, FastAPI, Click, etc.)
  • Structure: Project-specific directory layout
  • Configuration: Tailored configuration files

Technology Stack

  • Primary Framework: Selected during setup
  • Testing Framework: pytest with comprehensive coverage
  • Code Quality Tools: black, flake8, mypy
  • Security Tools: bandit, safety
  • Documentation: Auto-updating markdown system

Development Workflow

  • Guidelines: DEV_GUIDELINES.md with universal standards
  • Testing: TESTING_GUIDE.md with comprehensive framework
  • Requests: LLM_REQUEST_TEMPLATE.md for optimal development
  • Automation: Git hooks and CI/CD workflows

🏗️ Template Architecture

Core Components

AppDevelopmentTemplate/
├── README.md                      # This overview
├── PROJECT_TEMPLATE.md            # Gets customized per project
├── DEV_GUIDELINES.md              # Universal development standards
├── TESTING_GUIDE.md               # Comprehensive testing framework
├── LLM_REQUEST_TEMPLATE.md        # How to make development requests
├── 
├── .claude/
│   ├── instructions.md            # LLM automation instructions
│   └── project_context.md         # Project-specific context (generated)
├── 
├── scripts/
│   ├── setup_new_project.py       # Project customization
│   ├── install_dev_system.py      # Install automation system
│   ├── validate_*.py              # Quality validation scripts
│   └── update_documentation.py    # Auto-documentation system
├── 
├── tests/
│   ├── test_suite_runner.py       # Comprehensive test execution
│   └── test_*.py                  # Template test files
├── 
├── templates/
│   ├── flask_app_template/        # Flask application template
│   ├── cli_app_template/          # CLI application template
│   └── [other framework templates]
├── 
└── .github/workflows/             # CI/CD automation

Quality Standards

Every project created from this template automatically includes:

  • Test-Driven Development with >95% coverage requirement
  • Security-First Approach with automated vulnerability scanning
  • Performance Monitoring with response time enforcement
  • Documentation Automation that never gets out of sync
  • Code Quality Enforcement via automated formatting and linting

Automation Systems

  • Git Hooks for pre-commit validation and post-commit updates
  • CI/CD Workflows for continuous quality assurance
  • Documentation Updates triggered by code changes
  • Security Scanning integrated into development workflow
  • Performance Testing automated for regression detection

🎯 Success Metrics

Projects created from this template achieve:

  • Zero Documentation Debt (always up-to-date)
  • >95% Test Coverage maintained automatically
  • <500ms Response Times for web applications
  • Zero Security Vulnerabilities in production code
  • 100% Deployment Success Rate through comprehensive validation

🔄 Template Benefits

For Individual Developers

  • Consistent Quality across all projects
  • Automated Workflows reduce manual work
  • Best Practices applied automatically
  • Professional Standards without extra effort

For Teams

  • Standardized Practices across all developers
  • Quality Gates prevent low-quality code
  • Onboarding Efficiency with clear guidelines
  • Reduced Technical Debt through automation

For Organizations

  • Enterprise-Grade Quality from day one
  • Scalable Architecture patterns included
  • Security Compliance built-in
  • Maintenance Efficiency through automation

🚀 Template Evolution

This template incorporates lessons learned from:

  • Enterprise software development best practices
  • Open source project maintenance patterns
  • DevOps and CI/CD automation techniques
  • Security-first development methodologies
  • Performance optimization strategies

Continuous Improvement

The template evolves based on:

  • Real-world usage patterns
  • Emerging best practices
  • Framework updates and improvements
  • Security requirement changes
  • Performance optimization discoveries

📞 Getting Help

Template Documentation

  • DEV_GUIDELINES.md: Universal development standards
  • TESTING_GUIDE.md: Comprehensive testing framework
  • LLM_REQUEST_TEMPLATE.md: How to make optimal development requests

Validation Tools

# Validate project setup
python scripts/validate_project_setup.py

# Check development system
python scripts/validate_dev_system.py

# Test template functionality
python scripts/test_template_setup.py

Common Issues

  1. Setup Script Fails: Check Python version (3.9+ required)
  2. Git Hooks Not Working: Run python scripts/install_dev_system.py again
  3. Tests Failing: Ensure all dependencies installed with pip install -r requirements-dev.txt
  4. Documentation Not Updating: Verify git hooks are executable

🔮 Future Enhancements

Planned template improvements:

  • AI-Powered Code Generation with context awareness
  • Multi-Language Support (JavaScript, Go, Rust, etc.)
  • Cloud Deployment automation templates
  • Monitoring and Observability integration
  • Advanced Security scanning and compliance

This template represents the culmination of modern software development best practices, designed to make building high-quality applications effortless and automatic.

When you create a project from this template, this file gets replaced with project-specific information while maintaining all the quality standards and automation capabilities.