typescript-serverless-template

Template for TypeScript serverless applications.

Deploys an AWS Lambda application by utilizing Serverless Framework (v3). Env file (i.e., .env) is used for configuration.

Since this tries to follow the 3 Musketeers pattern, the following are heavily used:

• Docker
• Docker Compose
• Make

Usage

configure

$ make .env

• see generated .env file for configuration

Note: For deployment via CI/CD, CICD_MODE environment variable should be set to true in the build server. All env configuration should then be set in the build server's environment variables. They will automatically be used if .env is generated from .env.cicd. See Docker's handling of env variables from host environment for more details.

install dependencies (generate node_modules)

$ make deps

run linter (autofix)

$ make lint

run tests

$ make test

deploy serverless application

$ make deploy