awslabs / aws-api-gateway-developer-portal

A Serverless Developer Portal for easily publishing and cataloging APIs
Apache License 2.0
928 stars 400 forks source link

Missing instructions how to debug the portal #384

Closed okigan closed 4 years ago

okigan commented 4 years ago

Missing instructions how to debug the portal front end and/or backend (when running locally)

okigan commented 4 years ago

Checking in

ghost commented 4 years ago

For the front end, you can just open the developer tools and call it a day. For the backend, we do not currently have an easy mechanism to attach a debugger to it outside testing, though you can just run npx --inspect-brk jest --runInBand within lambdas/, pop open Chrome's dev tools, and click the Node logo to open a separate window for that to accomplish that during testing.

I have not tried running SAM locally with this project (though it's possible in theory), so I'm not entirely sure if/how that would work.

ghost commented 4 years ago

Now fixed: https://github.com/awslabs/aws-api-gateway-developer-portal/blob/master/BUILDING.md