README.md

---

@codebrew/nx-aws-cdk

An Nx plugin for developing aws-cdk

Table of Contents

• Install
• Usage
  • Generate Application
  • Targets
• Maintainers
• Contributing
• License

Install

# npm
npm install --save-dev @codebrew/nx-aws-cdk

# yarn
yarn add --dev @codebrew/nx-aws-cdk

Usage

Generate Application

Create Aws Cdk Application

nx generate @codebrew/nx-aws-cdk:application myApp

you can customize it further by passing these options:

nx generate @codebrew/nx-aws-cdk:application [name] [options,...]

Options:
  --name
  --tags                     Add tags to the project (used for linting)
  --directory                A directory where the project is placed
  --skipFormat               Skip formatting files
  --unitTestRunner           Adds the specified unit test runner (default: jest)
  --linter                   The tool to use for running lint checks. (default: eslint)
  --setParserOptionsProject  Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
  --dryRun                   Runs through and reports activity without writing to disk.
  --skip-nx-cache            Skip the use of Nx cache.
  --help                     Show available options for project target.

Targets

Generated applications expose several functions to the CLI that allow users to deploy, destroy and so on.

nx deploy {Project Name}
nx destroy {Project Name}

Maintainers

@tienne

Contributing

See the contributing file!

PRs accepted.

If editing the README, please conform to the standard-readme specification.

License

This project is MIT licensed 2021 David Kwon.