Project Name

Brief description of your project.

Prerequisites

• Terraform >= 1.0
• AWS CLI configured with appropriate credentials
• pre-commit (optional, for development)
• tflint (optional, for linting)

Quick Start

# Clone the repository
git clone https://github.com/your-username/your-repo.git
cd your-repo

# Initialize Terraform
cd terraform
terraform init

# Preview changes
terraform plan

# Apply changes
terraform apply

Project Structure

.
├── .github/
│   ├── workflows/
│   │   ├── lint.yml          # Pre-commit linting pipeline
│   │   └── sast.yml          # Security scanning pipeline
│   └── CODEOWNERS            # Code ownership definitions
├── cloudformation/           # CloudFormation templates
├── scripts/                  # Utility scripts
├── terraform/
│   ├── main.tf               # Main Terraform configuration
│   ├── variables.tf          # Input variables
│   ├── outputs.tf            # Output definitions
│   ├── providers.tf          # Provider configuration
│   └── versions.tf           # Version constraints
├── .gitignore
├── .pre-commit-config.yaml   # Pre-commit hooks configuration
├── .tflint.hcl               # TFLint configuration
├── .terraform-docs.yml       # Terraform docs configuration
├── CLAUDE.md                 # AI assistant guidance
├── LICENSE
├── Makefile
└── README.md

Branching Strategy

main (production)
 └── develop (integration)
      └── feature/* (new features)

Workflow

1. Create a feature branch from develop:

   git checkout develop
   git pull
   git checkout -b feature/my-feature

2. Make changes and commit:

   git add .
   git commit -m "feat: add my feature"

3. Push and create PR to develop:

   git push -u origin feature/my-feature

4. After review and merge to develop, create PR from develop to main for release.

Development

Setup Pre-commit Hooks

pip install pre-commit
pre-commit install

Available Make Targets

make help       # Show available targets
make init       # Initialize Terraform
make plan       # Run Terraform plan
make apply      # Apply changes
make fmt        # Format code
make lint       # Run linters
make test       # Run tests

Configuration

Variables

Security

This project includes automated security scanning via portfolio-code-scanner. Security scans run on:

• Push to main or develop branches
• Pull requests
• Daily scheduled runs

License

See LICENSE for details.