Merge pull request #43 from nimblehq/release/1.0.0

Release/1.0.0

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1 @@
+/dist

.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": ["oclif", "oclif-typescript"],
+  "rules": {
+    "unicorn/prefer-module": 0
+  }
+}

.github/ISSUE_TEMPLATE/bug_template.md

@@ -0,0 +1,20 @@
+---
+name: "Bug Report"
+about: "You found something that is not working. Report it so that it can be fixed. 👷‍"
+title: "Fix: "
+labels: "type : bug"
+---
+
+## Issue
+
+Describe the issue you are facing. Show us the implementation: screenshots, GIFs, etc.
+
+## Expected
+
+Describe what should be the correct behavior.
+
+## Steps to reproduce
+
+1. 
+2. 
+3. 

.github/ISSUE_TEMPLATE/chore_template.md

@@ -0,0 +1,14 @@
+---
+name: "Chore"
+about: "Open a chore issue for a minor update."
+title: "Update "
+labels: "type : chore"
+---
+
+## Why
+
+Describe the update in detail and why it is needed.
+
+## Who Benefits?
+
+Describe who will be the beneficiaries e.g. everyone, specific chapters, clients...

.github/ISSUE_TEMPLATE/feature_template.md

@@ -0,0 +1,14 @@
+---
+name: "Feature"
+about: "Open a feature issue to add new functionalities."
+title: "Add "
+labels: "type : feature"
+---
+
+## Why
+
+Describe the big picture of the feature and why it is needed.
+
+## Who Benefits?
+
+Describe who will be the beneficiaries e.g. everyone, specific chapters, clients...

.github/ISSUE_TEMPLATE/story_template.md

@@ -0,0 +1,22 @@
+---
+name: "Story"
+about: "Open a feature story"
+title: "[Type] As a user, I can "
+labels: "type : feature"
+---
+
+## Why
+
+Describe the idea of the user story as in what the motive of the user story is.
+
+## Acceptance Criteria
+
+List down how the user story will be tested and what criteria are necessary for the user story to be accepted.
+
+## Design
+
+(Optional) Add design screenshots or Figma links for UI/UX-related stories.
+
+## Resources
+
+(Optional) Add useful resources such as links to documentation, implementation ideas, or best practices.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,13 @@
-https://github.com/nimble/git-template/issues/??
+https://github.com/nimblehq/infrastructure-templates/issues/??
 
-## What happened
+## What happened 👀
 
-Describe the big picture of your changes here to communicate to the team why we should accept this pull request. 
-
-## Insight
+Describe the big picture of your changes here to communicate to the team why we should accept this pull request.
 
-Describe in details how to test the changes; referenced documentation is welcome as well.
-
-## Proof Of Work
+## Insight 📝
 
-Show us the implementation: screenshots, gif, etc.
+Describe in detail how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well.
+
+## Proof Of Work 📹
+
+Show us the implementation: screenshots, GIFs, etc.

.github/PULL_REQUEST_TEMPLATE/release_template.md

@@ -0,0 +1,19 @@
+Link to the milestone on Github e.g. https://github.com/nimblehq/infrastructure-templates/milestones/xx
+or
+Link to the project management tool for the release
+
+## Features
+
+Provide the ID and title of the issue in the section for each type (feature, chore and bug). The link is optional.
+
+- [#1] As a user, I can log in
+or
+- [[#1](https://github.com/nimblehq/infrastructure-templates/issues/1234)] As a user, I can log in
+
+## Chores
+
+- Same structure as in ## Feature
+
+## Bugs
+
+- Same structure as in ## Feature

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish package to npmjs
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    name: Publish package
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+          cache: "npm"
+          registry-url: "https://registry.npmjs.org"
+          scope: "@nimblehq"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish package to npmjs
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  test:
+    name: Run Tests
+    strategy:
+      matrix:
+        node-version: [16.x]
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Cache Node npm
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-infrastructure-templates-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-infrastructure-templates
+
+      - name: Install modules
+        run: yarn
+
+      - name: Run tests
+        run: yarn test

.gitignore

@@ -1,36 +1,9 @@
-*.gem
-*.rbc
-/.config
-/.idea
-/coverage/
-/InstalledFiles
-/node-modules
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+*-debug.log
+*-error.log
+/.nyc_output
+/dist
+/lib
+/package-lock.json
+/tmp
+node_modules
+oclif.manifest.json

.mocharc.json

@@ -0,0 +1,12 @@
+{
+  "require": [
+    "test/helpers/init.js",
+    "ts-node/register"
+  ],
+  "watch-extensions": [
+    "ts"
+  ],
+  "recursive": true,
+  "reporter": "spec",
+  "timeout": 60000
+}

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2018 Nimbl3 Ltd.
+Copyright (c) 2014 and onwards Nimble.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,29 +1,42 @@
-# Terrform Infrastructure  Template
+# Introduction
+
+Infrastructure (Terraform) configuration template for projects at Nimble.
 
 ## Usage
 
-1. Clone the repository
+1. Create a folder name and cd into that folder
+
+```bash
+mkdir awesome-infra && cd awesome-infra
+```
+
+2. Start the CLI to generate the infrastructure configuration in Terraform
 
-`git clone [email protected]:nimbl3/git-template.git`
+```bash
+npm install -g @nimblehq/infra-template
 
-2. Go to specific infrastructure that you would like to use and follow the specific instructions inside.
+nimble-infra generate {project-name}
+```
 
+* With npx:
+```bash
+npx @nimblehq/infra-template generate {project-name}
+```
 
 ## License
 
-This project is Copyright (c) 2014-2018 Nimbl3 Ltd. It is free software,
-and may be redistributed under the terms specified in the [LICENSE] file.
+This project is Copyright (c) 2014 and onwards Nimble. It is free software and may be redistributed under the terms specified in the [LICENSE] file.
 
 [LICENSE]: /LICENSE
 
 ## About
 
-![Nimbl3](https://dtvm7z6brak4y.cloudfront.net/logo/logo-repo-readme.jpg)
+![Nimble](https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png)
 
-This project is maintained and funded by Nimbl3 Ltd.
+This project is maintained and funded by Nimble.
 
 We love open source and do our part in sharing our work with the community!
 See [our other projects][community] or [hire our team][hire] to help build your product.
 
-[community]: https://nimbl3.github.io/
-[hire]: https://nimbl3.com/
+[community]: https://github.com/nimblehq
+[hire]: https://nimblehq.co/

bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*