Repository files navigation

Create CDK apps from templates.

View templateshere.

NPM

$ npx create-cdk-app<options><project-dir>

Yarn

$ yarn create cdk-app<options><project-dir>

If you choose adefault template, you will be prompted to choose a language. This is then passed to a child-process that runscdk init. This requiresaws-cdk to be installed and available in the context of the shell.

$ yarn create cdk-app -t default my-new-app

This will scaffold thedefault template into themy-new-app directory.

It is highly recommended that you set the following to environment variables:

GITHUB_USERNAME=<your username>GITHUB_TOKEN=<personal access|oauth token>

These will be pulled in and used for all github-related requests.

Github will rate-limit you to 5000 calls per hour if you're not using authentication. This limit is easily reached if you use a lot of other tools that are making these types of requests, or if you share an internet connection with many other people interacting with github.

Using authentication also comes with the added benefit of being able to use private repos as template sources.

Please review the templatecontributing documentation.

Please review thecontributing documentation.