Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.94 KB

README.md

File metadata and controls

76 lines (51 loc) · 2.94 KB
Raw

Talis CDK constructs

A Talis library of AWS CDK constructs, implemented in Typescript and currently Node v18.16.0

Contributing

This project follows conventional commits, and enforces this choice during the build and release cycle.

Builds are conducted by CircleCI, and upon successful build of the main branch, semantic-release will generate a new release, an appropriate version (based on commits), and release-notes to cover the content of the commit log.

Available constructs

  • CDN Site Hosting constructs

    • CdnSiteHostingConstruct for static-site or single-page application hosting in S3 via CloudFront.
    • CdnSiteHostingWithDnsConstruct for static-site or single-page application hosting in S3 via CloudFront, with DNS record provisioning

  • LambdaWorker

    • A serverless background job.
    • Possible replacement for Resque Workers / Jobs
    • Details here.

  • AuthenticatedApi

    • An API Gateway (v2)
    • Built in optional Persona authentication on routes
    • Details here.

  • TalisCdkStack

    • Base stack to be extended by talis stacks
    • Details here

Available Constants

  • TalisRegion

    • Aliases of AWS regions to the regions we deploy applications
    • Details here

  • TalisDeploymentEnvironment

    • Aliases and resuable constants for referencing our specific deployment environments.
    • Details here

Available Aspects

  • ResourcePrefixer

    • Prefixs all AWS resources with the given prefix
    • Details here

Useful commands

  • npm run build compile typescript to js
  • npm run watch watch for changes and compile
  • npm run infra-test perform the infra jest unit tests
  • npm run integration-test perform the integration tests
  • npm run lint will check code quality and style guidelines (using ESlint and Prettier)
  • npm run format will format the code (using Prettier)

Integration Tests

The integration tests are run against versions of the example projects deployed into AWS.

To run the integration tests locally:

  • export AWS_PREFIX=development-XX- where XX are your initials
  • The authenticated-lambda construct integration test needs the following environment variables for client/secrets. The values can be found by searching for talis-cdk-construct integration tests in keeper.
    • export TALIS_CDK_AUTH_API_MISSING_SCOPE_CLIENT=
    • export TALIS_CDK_AUTH_API_MISSING_SCOPE_SECRET=
    • export TALIS_CDK_AUTH_API_VALID_CLIENT=
    • export TALIS_CDK_AUTH_API_VALID_SECRET=
  • Following the instruction to deploy the simple-lambda-worker in the examples readme.
  • Following the instruction to deploy the simple-authenticated-api in the examples readme.
  • npm run integration-test