Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.58 KB

README.md

File metadata and controls

55 lines (42 loc) · 2.58 KB

DVLA Emerging Tech Lab CDK Tools

Projects

Quick Start

This is a monorepo that uses NPM workspaces and Lerna.

  • When you run npm install in the root folder, all dependencies of all packages are installed.
  • To install dependencies for a package use npm i <the-dependency> -w <package-name>.
  • Run a script using npm run <script> -w <package-name>, e.g npm run lint -w @dvla/lab-constructs-cdk
  • To run tests npm run test in the root folder. It will use the test script to run npm run test --workspaces, which runs the script in each workspace.

Some useful reference CDK resources

Commiting to Repository

Standardised commit messages are used on this repo using commitizen with a jira NPM package. Do the following to set it up:

  1. Install pre-commit hooks
brew install pre-commit
pre-commit install
  1. To commit to repository run npm run commit then follow the menu in the CLI
  2. To skip false positive rules SKIP=[hook-type] npm run commit

License

The MIT License (MIT)

Copyright (c) 2023 DVLA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.