{"id":18907759,"url":"https://github.com/infraspecdev/terraform-module-template","last_synced_at":"2025-09-06T06:44:57.428Z","repository":{"id":251325805,"uuid":"823072981","full_name":"infraspecdev/terraform-module-template","owner":"infraspecdev","description":"Template for create a terraform module","archived":false,"fork":false,"pushed_at":"2024-08-21T11:29:03.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-08-21T12:53:53.766Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infraspecdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-02T11:21:57.000Z","updated_at":"2024-08-21T11:29:06.000Z","dependencies_parsed_at":"2024-08-02T08:32:29.196Z","dependency_job_id":"35d9fe75-1817-4fea-bdc9-0578b2f45f06","html_url":"https://github.com/infraspecdev/terraform-module-template","commit_stats":null,"previous_names":["infraspecdev/terraform-module-template"],"tags_count":4,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infraspecdev%2Fterraform-module-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infraspecdev%2Fterraform-module-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infraspecdev%2Fterraform-module-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infraspecdev%2Fterraform-module-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infraspecdev","download_url":"https://codeload.github.com/infraspecdev/terraform-module-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223659441,"owners_count":17181350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T09:23:08.904Z","updated_at":"2025-09-06T06:44:57.415Z","avatar_url":"https://github.com/infraspecdev.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- BEGIN_TF_DOCS --\u003e\n# Terraform Module Template\n\nThis repository serves as a template for creating Terraform modules. It provides a structured approach to organizing and maintaining Terraform code, along with examples and best practices.\n\n## Table of Contents\n\n- [Prerequisites](#prerequisites)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Module Structure](#module-structure)\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n1. [install terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)\n2. [install pre-commit](https://pre-commit.com/#install)\n3. configure pre-commit: `pre-commit install`\n4. install required tools\n   - [tflint](https://github.com/terraform-linters/tflint)\n   - [terraform-docs](https://github.com/terraform-docs/terraform-docs)\n\n## Usage\n\nTo use this template, clone the repository and customize it according to your module's requirements. Below is a quick start guide:\n\n1. **Clone the repository:**\n\n   ```sh\n   git clone https://github.com/your-username/terraform-module-template.git\n   cd terraform-module-template\n   ```\n2. **Customize the module:**\n\n   - Update `main.tf`, `variables.tf`, `outputs.tf`, and `versions.tf` files as needed.\n   - Add your own resources and logic.\n3. **Run Terraform commands:**\n\n   ```sh\n   terraform init\n   terraform plan\n   terraform apply\n   ```\n\n## Examples\n\nThis repository includes example configurations to help you understand how to use the module:\n\n- **Complete Example:** Located in `examples/complete`\n\n  - Demonstrates a full-featured usage of the module.\n\n  ```sh\n  cd examples/complete\n  terraform init\n  terraform apply\n  ```\n- **Minimal Example:** Located in `examples/minimal`\n\n  - Shows a minimal configuration for using the module.\n\n  ```sh\n  cd examples/minimal\n  terraform init\n  terraform apply\n  ```\n\n## Module Structure\n\nThe repository is organized as follows:\n\n```plaintext\n.\n├── .editorconfig\n├── examples\n│   ├── complete\n│   │   ├── main.tf\n│   │   ├── outputs.tf\n│   │   ├── provider.tf\n│   │   ├── README.md\n│   │   ├── variables.tf\n│   │   └── versions.tf\n│   └── minimal\n│       ├── main.tf\n│       ├── outputs.tf\n│       ├── provider.tf\n│       ├── README.md\n│       ├── variables.tf\n│       └── versions.tf\n├── .github\n│   └── workflows\n│       ├── documentation.yaml\n│       ├── pre-commit.yaml\n│       └── pr-title.yaml\n├── .gitignore\n├── main.tf\n├── modules\n│   └── sample-resource\n│       ├── main.tf\n│       ├── outputs.tf\n│       ├── variables.tf\n│       └── version.tf\n├── outputs.tf\n├── .pre-commit-config.yaml\n├── README.md\n├── .terraform-docs.yml\n├── tests\n│   ├── examples_minimal.tftest.hcl\n│   └── unit_tests.tftest.hcl\n├── .tflint.hcl\n├── variables.tf\n└── versions.tf\n```\n\n## Reference [Getoutline](https://infraspec.getoutline.com/doc/terraform-Xkko7xHwM5) Document for Conventions to follow in your module\n\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.8.4 |\n\n## Providers\n\nNo providers.\n\n## Modules\n\nNo modules.\n\n## Resources\n\nNo resources.\n\n## Inputs\n\nNo inputs.\n\n## Outputs\n\nNo outputs.\n\u003c!-- END_TF_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfraspecdev%2Fterraform-module-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfraspecdev%2Fterraform-module-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfraspecdev%2Fterraform-module-template/lists"}