npm - @gradientedge/cdk-utils - Versions diffs - 4.2.3 → 4.4.0 - Mend

@gradientedge/cdk-utils 4.2.3 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (527) hide show

package/api-docs/tutorial-CI-CD.html ADDED Viewed

@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Gradient Edge CDK Utils CI-CD</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+                <a href="index.html">
+                    <h1 class="navbar-item">Gradient Edge CDK Utils Documentation</h1>
+                </a>
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    API Documentation
+                </a>
+                <div class="dropdown is-hoverable is-right">
+                    <a class="dropdown-trigger link">
+                        Tutorials
+                        <i class="fas fa-chevron-down fa-xs"></i>
+                    </a>
+                    <div class="dropdown-menu">
+                        <div class="dropdown-content">
+                            <a class="dropdown-item" href="tutorial-Architecture.html">
+                                Architecture
+                            </a>
+                            <a class="dropdown-item" href="tutorial-Build.html">
+                                Build
+                            </a>
+                            <a class="dropdown-item" href="tutorial-CI-CD.html">
+                                CI-CD
+                            </a>
+                            <a class="dropdown-item" href="tutorial-Development.html">
+                                Development
+                            </a>
+                        </div>
+                    </div>
+                </div>
+                        <a
+                            class="link user-link "
+                            href="https://github.com/gradientedge/cdk-utils"
+                        >
+                            Github
+                        </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar tutorials"
+            id="sidebarNav"
+        >
+                <div class="search-wrapper">
+                    <input id="search" type="text" placeholder="Search docs..." class="input">
+                </div>
+            <nav>
+                    <div class="category"><h3>Tutorials</h3><ul><li><a href="tutorial-Architecture.html">Architecture</a></li><li><a href="tutorial-Build.html">Build</a></li><li><a href="tutorial-CI-CD.html">CI-CD</a></li><li><a href="tutorial-Development.html">Development</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Tutorial</p>
+                    <h1>CI-CD</h1>
+                </header>
+                <section>
+<article>
+    <h2><img src="https://img.shields.io/badge/github--actions-4D4D4D?logo=github-actions&amp;style=for-the-badge&amp;logoColor=F8F8F5" alt="github-actions"></h2>
+<p>This project uses <a href="https://docs.github.com/en/actions">Github Actions</a> for Continuous Integration &amp; Delivery.</p>
+<h3>Workflows</h3>
+<h4><a href="/.github/workflows/ci.yml">CI</a></h4>
+<!-- references -->
+</article>
+</section>
+            </div>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+<script src="scripts/search.js"> </script>
+</body>
+</html>

package/api-docs/tutorial-Development.html ADDED Viewed

@@ -0,0 +1,223 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Gradient Edge CDK Utils Development</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+                <a href="index.html">
+                    <h1 class="navbar-item">Gradient Edge CDK Utils Documentation</h1>
+                </a>
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    API Documentation
+                </a>
+                <div class="dropdown is-hoverable is-right">
+                    <a class="dropdown-trigger link">
+                        Tutorials
+                        <i class="fas fa-chevron-down fa-xs"></i>
+                    </a>
+                    <div class="dropdown-menu">
+                        <div class="dropdown-content">
+                            <a class="dropdown-item" href="tutorial-Architecture.html">
+                                Architecture
+                            </a>
+                            <a class="dropdown-item" href="tutorial-Build.html">
+                                Build
+                            </a>
+                            <a class="dropdown-item" href="tutorial-CI-CD.html">
+                                CI-CD
+                            </a>
+                            <a class="dropdown-item" href="tutorial-Development.html">
+                                Development
+                            </a>
+                        </div>
+                    </div>
+                </div>
+                        <a
+                            class="link user-link "
+                            href="https://github.com/gradientedge/cdk-utils"
+                        >
+                            Github
+                        </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar tutorials"
+            id="sidebarNav"
+        >
+                <div class="search-wrapper">
+                    <input id="search" type="text" placeholder="Search docs..." class="input">
+                </div>
+            <nav>
+                    <div class="category"><h3>Tutorials</h3><ul><li><a href="tutorial-Architecture.html">Architecture</a></li><li><a href="tutorial-Build.html">Build</a></li><li><a href="tutorial-CI-CD.html">CI-CD</a></li><li><a href="tutorial-Development.html">Development</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Tutorial</p>
+                    <h1>Development</h1>
+                </header>
+                <section>
+<article>
+    <h2>Table of Contents</h2>
+<ul>
+<li><a href="#requirements">Requirements</a></li>
+<li><a href="#development-instructions">Setting up Development Environment</a></li>
+</ul>
+<h2>Requirements</h2>
+<h3>Mandatory</h3>
+<ul>
+<li><a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html">AWS CLI</a></li>
+<li><a href="https://nodejs.org/">Node</a></li>
+<li><a href="https://www.npmjs.com">Npm</a></li>
+<li><a href="https://yarnpkg.com">Yarn</a></li>
+</ul>
+<h3>Optional</h3>
+<ul>
+<li><a href="https://github.com/jorgebastida/awslogs">AWS Logs</a></li>
+<li><a href="https://github.com/joeyespo/grip">Grip</a></li>
+<li><a href="https://www.jetbrains.com/idea">JetBrains IntelliJ Idea</a>
+<ul>
+<li><a href="https://plugins.jetbrains.com/plugin/11349-aws-toolkit">AWS Toolkit</a></li>
+<li><a href="https://plugins.jetbrains.com/plugin/7371-aws-cloudformation">AWS CloudFormation</a></li>
+</ul>
+</li>
+<li><a href="https://github.com/nektos/act">Act</a></li>
+</ul>
+<h3>Docker system Requirements</h3>
+<table>
+<thead>
+<tr>
+<th>Resource</th>
+<th>Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>CPUs</td>
+<td><em>1 (more performant if &gt;2 available)</em></td>
+</tr>
+<tr>
+<td>Memory</td>
+<td><em>5 GB</em></td>
+</tr>
+<tr>
+<td>Swap</td>
+<td><em>1 GB</em></td>
+</tr>
+<tr>
+<td>Disk</td>
+<td><em>10 GB</em></td>
+</tr>
+</tbody>
+</table>
+<h2>Development Instructions</h2>
+<h3>Install the packages</h3>
+<h4><img src="https://img.shields.io/badge/command--line-4D4D4D?logo=windows-terminal&amp;style=for-the-badge" alt="cmd"></h4>
+<p>With <strong>npm</strong>:</p>
+<pre class="prettyprint source lang-shell"><code>npm install
+</code></pre>
+<p>With <strong>yarn</strong>:</p>
+<pre class="prettyprint source lang-shell"><code>yarn install
+</code></pre>
+<h3>Build the packages</h3>
+<h4><img src="https://img.shields.io/badge/command--line-4D4D4D?logo=windows-terminal&amp;style=for-the-badge" alt="cmd"></h4>
+<p>With <strong>npm</strong>:</p>
+<pre class="prettyprint source lang-shell"><code>npm run build
+</code></pre>
+<p>With <strong>yarn</strong>:</p>
+<pre class="prettyprint source lang-shell"><code>yarn build
+</code></pre>
+<h3>Test the packages</h3>
+<h4><img src="https://img.shields.io/badge/command--line-4D4D4D?logo=windows-terminal&amp;style=for-the-badge" alt="cmd"></h4>
+<p>With <strong>npm</strong>:</p>
+<pre class="prettyprint source lang-shell"><code>npm run validate
+</code></pre>
+<p>With <strong>yarn</strong>:</p>
+<pre class="prettyprint source lang-shell"><code>yarn validate
+</code></pre>
+<!-- references -->
+</article>
+</section>
+            </div>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+<script src="scripts/search.js"> </script>
+</body>
+</html>