Feature Proposal: CDK Project Generators
See original GitHub issue🚀 Feature Request
General Information
- 👋 I may be able to implement this feature request
- ⚠️ This feature might incur a breaking change
Description
An expansion of the cdk --init […] template system which would generate simple projects for very common use cases.
Proposed Solution
I propose providing a generator / templating solution, similar to a yeoman generator, which will go beyond what cdk --init provides.
Currently using cdk --init to create an application project will create a sample cdk infrastructure. Although this is helpful, I feel there is a gap for folks needing a quick boilerplate showing how to use cdk with a real world application - including cdk unit / integration tests, application source (Ie. api, static web files), ideal file structures for pipeline projects, etc.
Having a templating / generator system simple enough for developers in the community to understand will remove the burden of support from the CDK core team and provide a great repository of useful solutions for folks use. It will give them the opportunity to cut down the learning curve for teams internally as well, which is a pain point expressed by many, including myself.
AWS has some great venues for managing this sort of thing. I think templates and repositories are a specialty 😃
I look forward to any feedback!
As always I am a big fan and am happy to offer support in any way I can 😃
Environment
- CDK CLI Version:
- Module Version:
- OS:
- Language:
Other information
Issue Analytics
- State:
- Created 4 years ago
- Reactions:3
- Comments:5 (3 by maintainers)
Top GitHub Comments
@hoegertn I don’t know that sounds too easy…
I was thinking create something from scratch. Maybe in Assembly? 😂
That’s a great idea and something I think I can actually do! I might be able to yeomanize a project I’m almost finished with and kill two birds with one stone (contribute to the community and help my team).
Thanks for the input!
This sounds really great. You proposed something like yeoman, so why not use yeoman for this?
I think there could be templates for a Docker-based app, for serverless, etc.