question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

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:closed
  • Created 4 years ago
  • Reactions:3
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
jewelsjacobscommented, Aug 23, 2019

@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!

1reaction
hoegertncommented, Aug 23, 2019

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Your first AWS CDK app
This tutorial walks you through creating and deploying a simple AWS CDK app, from initializing the project to deploying the resulting AWS CloudFormation ......
Read more >
CDK for Terraform - HashiCorp Developer
You can make this choice for each team and project because CDK for ... Using TypeScript allows you to use the cdktf constructs...
Read more >
AWS CDK with Golang - poweruser.blog
This article will provide a brief look at deploying cloud infrastructure with AWS Cloud Development Kit (CDK) with Golang.
Read more >
CDK vs Terraform vs CloudFormation: A guide to IaC on AWS
CDK, Terraform or CloudFormation? Learn more about these Infrastructure as Code (IaC) tools on AWS, and find out which one is best for...
Read more >
Scaffold Generator: a Java library implementing molecular ...
Scaffold Generator: a Java library implementing molecular scaffold functionalities in the Chemistry Development Kit (CDK).
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found