How to run document generator on local env

(official doc: https://github.com/awslabs/aws-sam-local)

Pre-requisite

You will need to install the following DVSA packages to make sure you have the security checks required in place:

• git-secrets
• repo-security-scanner

Installation:

1. Install Docker (https://store.docker.com/editions/community/docker-ce-desktop-mac)
2. Install aws-sam-local: npm install -g aws-sam-local 2.1) Verify the installation worked: sam --version

Usage (run this command from root folder):

1. Invoke function: sam local invoke OR
2. Run API Gateway locally: sam local start-api

Debugging Applications:

1. Invoke a function locally in debug mode on port 5858: sam local invoke -d 5858 OR
2. Start local API Gateway in debug mode on port 5858: sam local start-api -d 5858
3. Hit endpoint: http://127.0.0.1:3000/
4. Run debugger

Architeture

Documentation for this service can be found here.