Skip to content

Commit

Permalink
Merge pull request #114 from nimblehq/release/1.2.0
Browse files Browse the repository at this point in the history
Release - 1.2.0
  • Loading branch information
hoangmirs authored Aug 31, 2022
2 parents 2168a3b + 57a9fa8 commit c4e2b2b
Show file tree
Hide file tree
Showing 48 changed files with 590 additions and 197 deletions.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
https://github.com/nimblehq/infrastructure-templates/issues/??
- Close #

## What happened 👀

Describe the big picture of your changes here to communicate to the team why we should accept this pull request.
Provide a description of the changes this pull request brings to the codebase. Additionally, when the pull request is still being worked on, a checklist of the planned changes is welcome to track progress.

## Insight 📝

Describe in detail how to test the changes, which solution you tried but did not go with, referenced documentation is welcome as well.
Describe in detail why this solution is the most appropriate, which solution you tried but did not go with, and how to test the changes. References to relevant documentation are welcome as well.

## Proof Of Work 📹

Expand Down
4 changes: 3 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
interval: "monthly"
open-pull-requests-limit: 3
versioning-strategy: increase-if-necessary
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ jobs:
run: npm ci

- name: Run tests
shell: bash
run: npm run test '--ignore-scripts' -- --watchAll=false --coverage --ci

- name: Upload test coverage
Expand Down
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
# Introduction
# Nimble Infrastructure Template

Infrastructure (Terraform) configuration template for projects at Nimble.
An infrastructure template for web applications powered by Terraform.

## Usage
**Supported cloud:** AWS. We are looking for contributions to implement support for GCP, Heroku, and Azure!

1. Create a folder name and cd into that folder
**Supported flavors:**
- A `Basic` flavor is in the plan, but not available yet
- The `Complete` flavor generates the following infrastructure:

```bash
mkdir awesome-infra && cd awesome-infra
```
![Diagram of the Complete Infrastructure](/img/diagram_complete.svg?raw=true)

2. Start the CLI to generate the infrastructure configuration in Terraform
## Usage

```bash
npm install -g @nimblehq/infra-template

nimble-infra generate {project-name}
```

* With npx:
or

```bash
npx @nimblehq/infra-template generate {project-name}
```
Expand All @@ -35,8 +36,10 @@ This project is Copyright (c) 2014 and onwards Nimble. It is free software and m

This project is maintained and funded by Nimble.

We love open source and do our part in sharing our work with the community!
We ❤️ 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.
Want to join? [Check out our jobs][jobs]!

[community]: https://github.com/nimblehq
[hire]: https://nimblehq.co/
[jobs]: https://jobs.nimblehq.co/
1 change: 1 addition & 0 deletions img/diagram_complete.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 46 additions & 46 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nimblehq/infra-template",
"version": "1.1.0",
"version": "1.2.0",
"description": "Nimble Infrastructure Template generator",
"author": "Nimblehq",
"bin": {
Expand Down Expand Up @@ -33,7 +33,7 @@
"@types/glob": "^7.2.0",
"@types/inquirer": "^8.2.1",
"@types/jest": "^28.1.6",
"@types/node": "^16.9.4",
"@types/node": "^18.7.6",
"chai": "^4.3.6",
"eslint": "^8.19.0",
"fs-extra": "^10.1.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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...
Original file line number Diff line number Diff line change
@@ -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...
Original file line number Diff line number Diff line change
@@ -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.
Loading

0 comments on commit c4e2b2b

Please sign in to comment.