gruntwork-io / boilerplate

A tool for generating files and folders ("boilerplate") from a set of templates
https://www.gruntwork.io
Mozilla Public License 2.0
157 stars 12 forks source link

Create a smaller scale reference architecture example to highlight boilerplate features #88

Closed yorinasub17 closed 2 years ago

yorinasub17 commented 2 years ago

Description

This PR moves all the existing examples to the examples/for-learning-and-testing folder, and adds in a full fledged examples/for-production folder. I recommend viewing the examples folder in the github browser to review this: https://github.com/gruntwork-io/boilerplate/tree/feature/for-production-example

This is the start of addressing https://github.com/gruntwork-io/boilerplate/issues/85, by providing a smaller scale, but complete example of how boilerplate templates in production should look like. This new example should demonstrate a lot of the patterns we invented in the Architecture Catalog in a more digestable format that is hopefully easier to follow and explain.

In the future, we can build a tutorial that works our way towards this end result.

TODOs

Please ensure all of these TODOs are completed before asking for a review.

yorinasub17 commented 2 years ago

NIT: Is it worth explaining a little about the ordering?

That probably makes sense. Let me merge this in because I am running into frequent merge conflicts due to the folder change in the examples, and then will push an iteration for the docs.

yorinasub17 commented 2 years ago

Thanks for review! (Intentionally keeping branch since I shared the link to the branch with Deloitte for feedback, and don't want them to get a 404)