structkit 3.0.0__py3-none-any.whl

structkit/contribs/project/generic.yaml

@@ -0,0 +1,309 @@
+files:
+  - .config/REMOVE_ME.md:
+      content: |
+        # .config Folder
+
+        It should local configuration related to setup on local machine.
+  - .build/REMOVE_ME.md:
+      content: |
+        # .build Folder
+
+        This folder should contain all scripts related to build process (PowerShell, Docker compose…).
+  - .dockerignore:
+      content: |
+        node_modules
+        npm-debug.log
+  - .editorconfig:
+      content: |
+        # Editor configuration
+        root = true
+
+        [*]
+        indent_style = space
+        indent_size = 2
+        end_of_line = lf
+        charset = utf-8
+        trim_trailing_whitespace = true
+        insert_final_newline = true
+  - .env:
+      content: |
+        # Environment variables
+        NODE_ENV=development
+        PORT=3000
+  - .env.example:
+      content: |
+        # Environment variables
+        NODE_ENV=development
+        PORT=3000
+  - .gitattributes:
+      content: |
+        # Auto detect text files and perform LF normalization
+        * text=auto
+  - .gitignore:
+      content: |
+        # Ignore files generated by the app
+        /node_modules
+        /dist
+  - .gitkeep:
+      content: ""
+  - .gitmodules:
+      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: |
+        # This file defines the submodules used by the repository
+        # See https://git-scm.com/docs/gitmodules
+
+        # Submodule for the app
+        [submodule "app"]
+          path = app
+          url =
+  - .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
+        *           @app-owner
+        .tf/*       @devops-team
+        .github/*   @devops-team
+        CODEOWNERS  @devops-team
+  - .github/CODE_OF_CONDUCT.md:
+      content: |
+        # Code of Conduct
+
+        This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/), which is a code of conduct for open source projects. Please read the [full text](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) so that you can understand what actions will and will not be tolerated.
+  - .github/CONTRIBUTING.md:
+      content: |
+        # Contributing
+
+        If you would like to contribute to this project, please follow the guidelines below.
+
+        ## Issues
+
+        - If you find a bug in the project, please open an issue on the [Issues](
+  - .github/FUNDING.yml:
+      content: |
+        github: app-owner
+  - .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/SECURITY.md:
+      content: |
+        # Security Policy
+
+        If you discover a security vulnerability within this project, please report it to the app owner at <email>. All security vulnerabilities will be promptly addressed.
+  - .github/dependabot.yml:
+      file: https://raw.githubusercontent.com/bitnami/charts/main/.github/dependabot.yml
+  - .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/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
+  - .mailmap:
+      content: |
+        # This file maps authors and committers to their canonical names and email addresses
+        # See https://git-scm.com/docs/git-check-mailmap
+
+        # Canonical name and email address for the app owner
+        # app-owner <
+  - ACKNOWLEDGEMENTS.md:
+      content: |
+        # Acknowledgements
+
+        This project would not have been possible without the help of the following people:
+
+        - app-owner <
+  - AUTHORS.md:
+      content: |
+        # Authors
+
+        This project was created by app-owner <
+
+        ## Contributors
+
+        - app-owner <
+  - CHANGELOG.md:
+      content: |
+        # Changelog
+
+        All notable changes to this project will be documented in this file.
+
+        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+        and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+        ## [Unreleased]
+
+        ## [1.0.0] - 2021-01-01
+        ### Added
+        - Initial release
+  - CONTRIBUTORS.md:
+      content: |
+        # Contributors
+
+        Thanks to the following people who have contributed to this project:
+
+        - app-owner <
+  - Dockerfile:
+      content: |
+        # Use an official Node.js runtime as the base image
+        FROM node:14
+        # Set the working directory in the container
+        WORKDIR /app
+        # Copy package.json and package-lock.json
+        COPY package*.json ./
+        # Install Node.js dependencies
+        RUN npm install
+        # Copy the application code
+        COPY . .
+        # Expose the port the app runs on
+        EXPOSE 3000
+        # Run the application
+        CMD ["npm", "start"]
+  - LICENSE:
+      file: https://raw.githubusercontent.com/httpdss/structkit/main/LICENSE
+  - README.md:
+      content: |
+        # Generic App
+
+        ## Introduction
+
+        This is a generic app that can be used as a template for new projects.
+
+        ## Contribute
+
+        If you would like to contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
+
+        ## License
+
+        This project is licensed under the terms of the [Apache 2.0](LICENSE) license.
+  - dep/REMOVE_ME.md:
+      content: |
+        # dep Folder
+
+        This is the directory where all your dependencies should be stored.
+  - docker-compose.yml:
+      content: |
+        version: '3'
+        services:
+          app:
+            build: .
+            ports:
+              - "3000:3000"
+            env_file:
+              - .env
+            volumes:
+              - .:/app
+            environment:
+              - NODE_ENV=development
+  - doc/REMOVE_ME.md:
+      content: |
+        # doc Folder
+
+        The documentation folder
+  - res/REMOVE_ME.md:
+      content: |
+        # res Folder
+
+        For all static resources in your project. For example, images.
+  - samples/REMOVE_ME.md:
+      content: |
+        # samples Folder
+
+        Providing “Hello World” & Co code that supports the documentation.
+  - src/REMOVE_ME.md:
+      content: |
+        # src Folder
+
+        The source code folder! However, in languages that use headers (or if you have a framework for your application) don’t put those files in here.
+  - test/REMOVE_ME.md:
+      content: |
+        # test Folder
+
+        Unit tests, integration tests… go here.
+  - tools/REMOVE_ME.md:
+      content: |
+        # tools Folder
+
+        Convenience directory for your use. Should contain scripts to automate tasks in the project, for example, build scripts, rename scripts. Usually contains .sh, .cmd files for example.
+
+folders:
+  - .devops/apps/environments/prod:
+      struct: terraform/module
+  - .devops/apps/environments/stage:
+      struct: terraform/module
+  - .devops/apps/environments/qa:
+      struct: terraform/module
+  - .devops/apps/environments/dev:
+      struct: terraform/module
+  - .devops/apps/init:
+      struct: terraform/module
+  - ./:
+      struct:
+      - github/workflows/pre-commit
+      - github/workflows/release-drafter

structkit/contribs/project/go.yaml

@@ -0,0 +1,104 @@
+files:
+  - .editorconfig:
+      content: |
+        # Editor configuration
+        root = true
+
+        [*]
+        indent_style = space
+        indent_size = 2
+        end_of_line = lf
+        charset = utf-8
+        trim_trailing_whitespace = true
+        insert_final_newline = true
+  - .env:
+      content: |
+        # Environment variables
+  - .env.example:
+      content: |
+        # Environment variables
+  - .gitignore:
+      content: |
+        # Ignore files generated by the app
+        .env
+        .venv
+  - LICENSE:
+      file: https://raw.githubusercontent.com/httpdss/structkit/main/LICENSE
+  - README.md:
+      content: |
+        # Generic App
+
+        ## Introduction
+
+        This is a generic app that can be used as a template for new projects.
+
+        ## Contribute
+
+        If you would like to contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
+
+        ## License
+
+        This project is licensed under the terms of the [Apache 2.0](LICENSE) license.
+  - main.go:
+      content: |
+        package main
+
+        import "fmt"
+
+        func main() {
+          fmt.Println("Hello, World!")
+        }
+  - cmd/project_name/main.go:
+      content: |
+        package main
+
+        import "fmt"
+
+        func main() {
+          fmt.Println("Hello, World!")
+        }
+  - pkg/project_name/module1.go:
+      content: |
+        package project_name
+
+        import "fmt"
+
+        func Module1() {
+          fmt.Println("Module 1")
+        }
+  - pkg/project_name/module2.go:
+      content: |
+        package project_name
+
+        import "fmt"
+
+        func Module2() {
+          fmt.Println("Module 2")
+        }
+  - internal/project_name/util.go:
+      content: |
+        package project_name
+
+        import "fmt"
+
+        func Util() {
+          fmt.Println("Util")
+        }
+  - api/v1/api.go:
+      content: |
+        package v1
+
+        import "fmt"
+
+        func API() {
+          fmt.Println("API")
+        }
+  - test/main_test.go:
+      content: |
+        package main
+
+        import "testing"
+
+        func TestMain(t *testing.T) {
+          t.Log("Testing main")
+        }

structkit/contribs/project/java.yaml

@@ -0,0 +1,85 @@
+files:
+  - .editorconfig:
+      content: |
+        # Editor configuration
+        root = true
+
+        [*]
+        indent_style = space
+        indent_size = 2
+        end_of_line = lf
+        charset = utf-8
+        trim_trailing_whitespace = true
+        insert_final_newline = true
+  - .env:
+      content: |
+        # Environment variables
+  - .env.example:
+      content: |
+        # Environment variables
+  - .gitignore:
+      content: |
+        # Ignore files generated by the app
+        .env
+        .venv
+  - LICENSE:
+      file: https://raw.githubusercontent.com/httpdss/structkit/main/LICENSE
+  - README.md:
+      content: |
+        # Generic App
+
+        ## Introduction
+
+        This is a generic app that can be used as a template for new projects.
+
+        ## Contribute
+
+        If you would like to contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
+
+        ## License
+
+        This project is licensed under the terms of the [Apache 2.0](LICENSE) license.
+  - pom.xml:
+      content: |
+        <project xmlns="http://maven.apache.org/POM/4.0.0"
+                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+          <modelVersion>4.0.0</modelVersion>
+          <groupId>com.example</groupId>
+          <artifactId>project_name</artifactId>
+          <version>0.1.0</version>
+          <packaging>jar</packaging>
+          <name>project_name</name>
+          <description>A new Java project</description>
+          <properties>
+            <maven.compiler.source>1.8</maven.compiler.source>
+            <maven.compiler.target>1.8</maven.compiler.target>
+          </properties>
+        </project>
+  - src/main/java/com/example/App.java:
+      content: |
+        package com.example;
+
+        public class App {
+            public static void main(String[] args) {
+                System.out.println("Hello, World!");
+            }
+        }
+  - src/main/resources/REMOVE_ME.md:
+      content: |
+        # Resources
+
+        Resource files like configuration files
+  - src/test/java/com/example/AppTest.java:
+      content: |
+        package com.example;
+
+        import org.junit.Test;
+        import static org.junit.Assert.*;
+
+        public class AppTest {
+            @Test
+            public void testApp() {
+                assertTrue(true);
+            }
+        }

structkit/contribs/project/n8n.yaml

@@ -0,0 +1,100 @@
+files:
+  - .gitignore:
+      content: |
+        # Ignore env files
+        .env
+  - .env:
+      content: |
+        # DOMAIN_NAME and SUBDOMAIN together determine where n8n will be reachable from
+        # The top level domain to serve from
+        DOMAIN_NAME={{@ n8n_domain_name @}}
+
+        # The subdomain to serve from
+        SUBDOMAIN={{@ n8n_subdomain @}}
+
+        # The above example serve n8n at: https://{{@ n8n_subdomain @}}.{{@ n8n_domain_name @}}
+
+        # Optional timezone to set which gets used by Cron and other scheduling nodes
+        # New York is the default value if not set
+        GENERIC_TIMEZONE={{@ n8n_generic_timezone @}}
+
+        # The email address to use for the TLS/SSL certificate creation
+        SSL_EMAIL={{@ n8n_ssl_email @}}
+  - local-files/.gitkeep:
+      content: |
+        # Keep this file to ensure the local-files directory is included in version control
+  - docker-compose.yaml:
+      content: |
+        services:
+          traefik:
+            image: "traefik"
+            restart: always
+            command:
+              - "--api.insecure=true"
+              - "--providers.docker=true"
+              - "--providers.docker.exposedbydefault=false"
+              - "--entrypoints.web.address=:80"
+              - "--entrypoints.web.http.redirections.entryPoint.to=websecure"
+              - "--entrypoints.web.http.redirections.entrypoint.scheme=https"
+              - "--entrypoints.websecure.address=:443"
+              - "--certificatesresolvers.mytlschallenge.acme.tlschallenge=true"
+              - "--certificatesresolvers.mytlschallenge.acme.email=${SSL_EMAIL}"
+              - "--certificatesresolvers.mytlschallenge.acme.storage=/letsencrypt/acme.json"
+            ports:
+              - "80:80"
+              - "443:443"
+            volumes:
+              - traefik_data:/letsencrypt
+              - /var/run/docker.sock:/var/run/docker.sock:ro
+
+          n8n:
+            image: docker.n8n.io/n8nio/n8n
+            restart: always
+            ports:
+              - "127.0.0.1:5678:5678"
+            labels:
+              - traefik.enable=true
+              - traefik.http.routers.n8n.rule=Host(`${SUBDOMAIN}.${DOMAIN_NAME}`)
+              - traefik.http.routers.n8n.tls=true
+              - traefik.http.routers.n8n.entrypoints=web,websecure
+              - traefik.http.routers.n8n.tls.certresolver=mytlschallenge
+              - traefik.http.middlewares.n8n.headers.SSLRedirect=true
+              - traefik.http.middlewares.n8n.headers.STSSeconds=315360000
+              - traefik.http.middlewares.n8n.headers.browserXSSFilter=true
+              - traefik.http.middlewares.n8n.headers.contentTypeNosniff=true
+              - traefik.http.middlewares.n8n.headers.forceSTSHeader=true
+              - traefik.http.middlewares.n8n.headers.SSLHost=${DOMAIN_NAME}
+              - traefik.http.middlewares.n8n.headers.STSIncludeSubdomains=true
+              - traefik.http.middlewares.n8n.headers.STSPreload=true
+              - traefik.http.routers.n8n.middlewares=n8n@docker
+            environment:
+              - N8N_HOST=${SUBDOMAIN}.${DOMAIN_NAME}
+              - N8N_PORT=5678
+              - N8N_PROTOCOL=https
+              - NODE_ENV=production
+              - WEBHOOK_URL=https://${SUBDOMAIN}.${DOMAIN_NAME}/
+              - GENERIC_TIMEZONE=${GENERIC_TIMEZONE}
+            volumes:
+              - n8n_data:/home/node/.n8n
+              - ./local-files:/files
+
+        volumes:
+          n8n_data:
+          traefik_data:
+
+variables:
+  - n8n_domain_name:
+      description: "The top level domain to serve n8n from"
+      type: string
+      default: "localtest.me"
+  - n8n_subdomain:
+      description: "The subdomain to serve n8n from"
+      type: string
+      default: "n8n"
+  - n8n_generic_timezone:
+      description: "The timezone to set for n8n, used by Cron and scheduling nodes"
+      type: string
+      default: "America/New_York"
+  - n8n_ssl_email:
+      description: "The email address to use for TLS/SSL certificate creation"
+      type: string

structkit/contribs/project/nodejs.yaml

@@ -0,0 +1,101 @@
+files:
+  - .editorconfig:
+      content: |
+        # Editor configuration
+        root = true
+
+        [*]
+        indent_style = space
+        indent_size = 2
+        end_of_line = lf
+        charset = utf-8
+        trim_trailing_whitespace = true
+        insert_final_newline = true
+  - .env:
+      content: |
+        # Environment variables
+  - .env.example:
+      content: |
+        # Environment variables
+  - .gitignore:
+      content: |
+        # Ignore files generated by the app
+        .env
+        .venv
+  - LICENSE:
+      file: https://raw.githubusercontent.com/httpdss/structkit/main/LICENSE
+  - README.md:
+      content: |
+        # Generic App
+
+        ## Introduction
+
+        This is a generic app that can be used as a template for new projects.
+
+        ## Contribute
+
+        If you would like to contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
+
+        ## License
+
+        This project is licensed under the terms of the [Apache 2.0](LICENSE) license.
+  - package.json:
+      content: |
+        {
+          "name": "project_name",
+          "version": "0.1.0",
+          "description": "A new Node.js project",
+          "main": "index.js",
+          "scripts": {
+            "test": "echo \"Error: no test specified\" && exit 1"
+          },
+          "keywords": [],
+          "author": "",
+          "license": "Apache-2.0",
+          "dependencies": {},
+          "devDependencies": {}
+        }
+  - test/index.test.js:
+      content: |
+        const assert = require('assert');
+
+        describe('Array', function() {
+          describe('#indexOf()', function() {
+            it('should return -1 when the value is not present', function() {
+              assert.strictEqual([1, 2, 3].indexOf(4), -1);
+            });
+          });
+        });
+  - src/index.js:
+      content: |
+        console.log('Hello, World!');
+  - src/utils.js:
+      content: |
+        function add(a, b) {
+          return a + b;
+        }
+
+        function sub(a, b) {
+          return a - b;
+        }
+
+        module.exports = { add, sub };
+  - public/index.html:
+      content: |
+        <!DOCTYPE html>
+        <html lang="en">
+        <head>
+          <meta charset="UTF-8">
+          <meta http-equiv="X-UA-Compatible" content="IE=edge">
+          <meta name="viewport" content="width=device-width, initial-scale=1.0">
+          <title>Document</title>
+        </head>
+        <body>
+          <h1>Hello, World!</h1>
+        </body>
+        </html>
+  - public/styles.css:
+      content: |
+        body {
+          font-family: Arial, sans-serif;
+        }