Gilbertly / sls-starter-ts

Serverless framework Typescript starter kit.

Project Template: aws-typescript

Setup

First ensure that you have exported the relevant AWS credentials for your environment, with the command:

// expose aws profile credentials
$ export AWS_PROFILE=<PROFILE_NAME>

SSM Parameters: download

Downloads existing project secrets from AWS environment to local file:

// download existing secrets from an ssm path
$ npm run ssm:download <SSM_PATH> <FILENAME>
$ npm run ssm:download /starter_ts/ dev

SSM Parameters: update

Creates or updates project secrets onto an AWS environment:

// create a new secrets file, eg. `./config/ssm.dev.json`
$ touch ./config/ssm.dev.json

// create or update secrets from a file
$ npm run ssm:update <FILENAME>
$ npm run ssm:update dev

SSM Parameters: delete

Removes project secrets added in an AWS environment:

// remove secrets from a file
$ npm run ssm:delete <FILENAME>
$ npm run ssm:delete dev

Validate Project Setup

Validates your development environment:

$ npm run validate:all

// start apigateway + dynamodb localhost
$ npm run ddb:install
$ npm run api:start

NOTE: Run the command npm run ddb:install initially, and not everytime you are starting apigateway + dynamodb locally.