ra-route-management v0.0.8

ra-route-management

Ra: The sun god

Prerequisites

Before getting started, make sure you have the following credentials, tools, and CLIs installed:

• AWS Development Credentials
• AWS CLI
• AWS SAM
• nvm - NOTE: ensure node v18.16.0 is installed

New Dev Setup

Follow these steps to set up the repository for the first time:

Run the following commands to set up the project:

# npm install
npm install

# Install the git hooks
npx husky install

Modifying Dependencies and Configurations

This is a Projen-managed repo.

Projen is a configuration management tool. We are using it to manage configs for CDK, NPM/Node, tsc, Jest, and other tools.

This means you cannot edit these config files directly! Instead, you must make your changes in .projenrc.ts and then run npx projen to trigger a Projen run, which will synthesize new config files from the Projenrc file. Any changes made directly into config files (including package.json) will be thrown out by Projen!

Directory Structure

└── src/
    ├── handlers/   - Lambda handlers
    ├── logic/      - Core logic used across lambdas
    ├── stacks/     - CDK infrastructure-as-code stacks
    ├── tests/      - Utilities to enable testing. (Note: Test files are collocated with the files they test)
    ├── types/      - TypeScript definitions
    └── utils/      - Miscellaneous utilities

Testing

Run npm run test to run the tests once. Run npm run test:watch to run the tests continuously.

Deploying

DEV - npm run deploy:dev

STAGING - npm run deploy:staging

PROD - npm run deploy:prod

Check stack changes

• Synth to check the stack compiles: npm run synth:staging
• Diff to check what change: npm run diff:prod