https://github.com/spencerbeggs/aws-cdk-stack-factory

A bootstrap-able template for building, testing and deploying AWS CDK stacks and constructs with a Node.js cli.
https://github.com/spencerbeggs/aws-cdk-stack-factory

aws aws-cdk boilerplate-template

Last synced: 28 days ago
JSON representation

A bootstrap-able template for building, testing and deploying AWS CDK stacks and constructs with a Node.js cli.

• Host: GitHub
• URL: https://github.com/spencerbeggs/aws-cdk-stack-factory
• Owner: spencerbeggs
• License: mit
• Created: 2020-02-20T05:11:21.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T02:34:01.000Z (almost 2 years ago)
• Last Synced: 2024-08-07T08:15:06.450Z (5 months ago)
• Topics: aws, aws-cdk, boilerplate-template
• Language: TypeScript
• Homepage:
• Size: 4.64 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AWS CDK Stack Factory 🏭

This repo is bootstrap-able template for building, testing and deploying [AWS Cloud Development Kit](https://docs.aws.amazon.com/cdk/latest/guide/home.html) stacks and constructs in [Typescript](https://www.typescriptlang.org/). It works by using a simple file structure to define stacks, optionally pass variables to them from JSON files and proxy commands to the [AWS CDK Toolkit cli](https://docs.aws.amazon.com/cdk/latest/guide/tools.html) from npm/yarn scripts.

This repository is a [GitHub template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template), so you can quickly clone it into your own repo and start tinkering. Just hit the "Use this template" button on the [this repo's GitHub page](https://github.com/spencerbeggs/aws-cdk-stack-factory) when you are logged in. This repo contains demo stack, construct and test files.

You can bootstrap this repository into a testable and ready-to-use state with: `yarn bootstrap`.

If you are new here, [read the documentation](docs):

- [Environment Setup](docs/setup)

- [Creating Stacks and Constructs](docs/usage)

- [Testing Your Code](docs/testing)

- [Workflow Helpers](docs/workflow)

## Help Improve AWS CDK

If you love working with AWS CDK, you can use this repo to help [the team building CDK](https://github.com/aws/aws-cdk) improve it. Bootstrap this  repo and setup stacks and constructs and with unit tests. They are very friendly and responsive to bug reports and feature requests. Do your part and provide them with tests cases when you [file issues](https://github.com/aws/aws-cdk/issues) 💪.

## Credits and Contributing

This repo borrows from and builds upon many of the ideas from the [Open CDK Guide](https://github.com/kevinslin/open-cdk). If you want to improve this template, please [open an issue](https://github.com/spencerbeggs/aws-cdk-stack-factory/issues) or [pull request](https://github.com/spencerbeggs/aws-cdk-stack-factory/pulls).