chore: Update pull request template and contributing guidelines

Author: httpdss

README.md

@@ -1,12 +1,12 @@
-# STRUCT: Automated Project Structure Generator
+# 🚀 STRUCT: Automated Project Structure Generator
 
 ![Struct Banner](extras/banner.png)
 
 > ⚠️ **Warning:** This project is still in development and may contain bugs. Use it at your own risk.
 
 STRUCT is a powerful and flexible script designed to automate the creation of project structures based on YAML configurations. It supports template variables, custom file permissions, remote content fetching, and multiple file handling strategies to streamline your development setup process.
 
-## Features
+## ✨ Features
 
 - **YAML Configuration**: Define your project structure in a simple YAML file.
 - **Template Variables**: Use placeholders in your configuration and replace them with actual values at runtime.
@@ -17,7 +17,7 @@ STRUCT is a powerful and flexible script designed to automate the creation of pr
 - **Configuration Validation**: Ensure your YAML configuration is valid before executing the script.
 - **Verbose Logging**: Get detailed logs of the script's actions for easy debugging and monitoring.
 
-## Installation
+## 🛠️ Installation
 
 You can install STRUCT using pip:
 
@@ -27,7 +27,7 @@ pip install git+https://github.com/httpdss/struct.git
 
 Alternatively, you can clone the repository and install it locally. see the [Development](#development) section for more details.
 
-## Quick Start using Docker
+## 🐳 Quick Start using Docker
 
 You can run STRUCT using Docker without installing it on your system. Here's how you can do it:
 
@@ -38,12 +38,13 @@ You can run STRUCT using Docker without installing it on your system. Here's how
 docker run \
   -v $(pwd):/workdir \
   -e OPENAI_API_KEY=your-key \
+  -u $(id -u):$(id -g) \
   ghcr.io/httpdss/struct:main \
-  /workdir/structure.yaml \
-  .
+  /workdir/example/structure.yaml \
+  /workdir/example_output
 ```
 
-## Using docker alpine
+## 🐳 Using docker alpine
 
 ```sh
 docker run -it --entrypoint="" python:3.10-alpine sh -l
@@ -62,7 +63,7 @@ export OPENAI_API_KEY=something
 struct structure.yaml .
 ```
 
-## Usage
+## 📝 Usage
 
 Run the script with the following command:
 
@@ -98,7 +99,7 @@ struct \
   /path/to/your/output/directory
 ```
 
-## YAML Configuration
+## 📄 YAML Configuration
 
 Here is an example of a YAML configuration file:
 
@@ -121,7 +122,7 @@ structure:
 
 ```
 
-## Development
+## 👩‍💻 Development
 
 To get started with development, follow these steps:
 
@@ -140,18 +141,22 @@ pip install -r requirements.txt
 pip install -r requirements.dev.txt
 ```
 
-## License
+## 📜 License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-## Funding
+## 💰 Funding
 
 If you find this project helpful, please consider supporting it through donations: [patreon/structproject](https://patreon.com/structproject)
 
-## Contributing
+## 🤝 Contributing
 
 Contributions are welcome! Please open an issue or submit a pull request.
 
-## Acknowledgments
+## 🙏Acknowledgments
 
 Special thanks to all the contributors who helped make this project possible.
+
+## 🐞 Known Issues
+
+- [ ] Its mandatory that you set the `OPENAI_API_KEY` environment variable before running the script. if you are not using gpt properties, you can set it to any value. Issue [#3](https://github.com/httpdss/struct/issues/3)

contribs/generic-app.yaml

@@ -0,0 +1,107 @@
+structure:
+  - README.md:
+      content: |
+        # Generic App
+
+        This is a generic app that can be used as a starting point for new projects.
+  - .gitignore:
+      content: |
+        # Ignore files generated by the app
+        /node_modules
+        /dist
+  - .devops/apps/environments/dev/main.tf:
+      content: "# Terraform configuration for the dev environment"
+  - .devops/apps/environments/dev/providers.tf:
+      content: |
+        provider "aws" {
+          region = "${ aws_region }"
+        }
+  - .devops/apps/environments/prod/main.tf:
+      content: "# Terraform configuration for the prod environment"
+  - .devops/apps/environments/prod/providers.tf:
+      content: |
+        provider "aws" {
+          region = "${ aws_region }"
+        }
+  - .devops/apps/environments/stage/main.tf:
+      content: "# Terraform configuration for the stage environment"
+  - .devops/apps/environments/stage/providers.tf:
+      content: |
+        provider "aws" {
+          region = "${ aws_region }"
+        }
+  - .devops/apps/environments/qa/main.tf:
+      content: "# Terraform configuration for the qa environment"
+  - .devops/apps/environments/qa/providers.tf:
+      content: |
+        provider "aws" {
+          region = "${ aws_region }"
+        }
+  - .devops/apps/init/main.tf:
+      content: "# Terraform configuration for the init environment"
+  - .devops/apps/init/providers.tf:
+      content: |
+        provider "aws" {
+          region = "${ aws_region }"
+        }
+  - .github/workflows/pre-commit.yaml:
+      content: |
+        repos:
+        - repo: https://github.com/pre-commit/pre-commit-hooks
+          rev: v4.6.0
+          hooks:
+            - id: trailing-whitespace
+            - id: end-of-file-fixer
+            - id: check-yaml
+  - .github/workflows/ci.yaml:
+      content: |
+        name: CI
+
+        on:
+          push:
+            branches:
+              - main
+
+        jobs:
+          build:
+            runs-on: ubuntu-latest
+
+            steps:
+              - name: Checkout code
+                uses: actions/checkout@v2
+
+              - name: Install dependencies
+                run: npm install
+
+              - name: Build
+                run: npm run build
+
+              - name: Test
+                run: npm test
+
+              - name: Deploy
+                run: echo "Deploying to the cloud"
+  - .github/CODEOWNERS:
+      content: |
+        # This file defines the code owners for the repository
+        # See https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+        # The owners of the repository
+        * @github-owner
+  - .pre-commit-config.yaml:
+      content: |
+        repos:
+        - repo: https://github.com/pre-commit/pre-commit-hooks
+          rev: v4.6.0
+          hooks:
+            - id: trailing-whitespace
+            - id: end-of-file-fixer
+            - id: check-yaml
+  - .github/ISSUE_TEMPLATE/bug_report.md:
+      file: https://raw.githubusercontent.com/bitnami/charts/main/.github/ISSUE_TEMPLATE/bug_report.yml
+  - .github/ISSUE_TEMPLATE/feature_request.md:
+      file: https://raw.githubusercontent.com/bitnami/charts/main/.github/ISSUE_TEMPLATE/feature_request.yml
+  - .github/PULL_REQUEST_TEMPLATE.md:
+      file: https://raw.githubusercontent.com/bitnami/charts/main/.github/PULL_REQUEST_TEMPLATE.md
+  - .github/dependabot.yml:
+      file: https://raw.githubusercontent.com/bitnami/charts/main/.github/dependabot.yml