ZAR CDK Library

Official documentation: zar-cdk-lib.production.zarhq.dev

Overview

This library is build & published as NPM module in GitHub packages (Python and others coming later).

To install this library in TypeScript CDK projects:

• Point the project to GitHub Packages by creating .npmrc file in the project directory with following content:

  @zarpay:registry=https://npm.pkg.github.com/
  //npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
  Copy

• Authenticate to GH packages. See Configuring npm for use with GitHub Packages for details
• Install the module:

  yarn add @zarpay/zar-cdk-lib
  Copy

To use the library constructs in a CDK project (example):

import {ApplicationLoadBalancedFargateService} from "@zarpay/zar-cdk-lib";

new ZarCdkLib(this, 'ZarCdkLib', {
    ...
})
Copy

Useful commands

• yarn build compile typescript to js
• yarn watch watch for changes and compile
• yarn test perform the jest unit tests

Contributing

This CDK library repo is maintained by DevOps team, but we would like to encourage the dev community to contribute to it. Please see the Contributing Guide for details, including suggestions how to setup the development environment.