Skip to content

improve LocalDebugging readme #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Examples/LocalDebugging/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Local Debugging Example

This sample project demonstrates how to write a simple Lambda function in Swift,
and how to use local debugging techniques that emulate how the Lambda function
and how to use local debugging techniques that simulate how the Lambda function
would be invoked by the AWS Lambda Runtime engine.

The example includes three modules:
The example includes an Xcode workspace with three modules:

1. [MyApp](MyApp) is a SwiftUI iOS application that calls the Lambda function.
2. [MyLambda](MyLambda) is a SwiftPM executable package for the Lambda function.
Expand All @@ -16,11 +16,11 @@ debug-only local lambda engine simulator which starts a local HTTP server enabli
between the iOS application and the Lambda function over HTTP.

To try out this example, open the workspace in Xcode and "run" the two targets,
using the relevant `MyLambda` and `MyApp` Xcode schemas.
using the relevant `MyLambda` and `MyApp` Xcode schemes.

Start with running the `MyLambda` target.
* Switch to the `MyApp` scheme and select the "My Mac" destination
* Set the `LOCAL_LAMBDA_SERVER_ENABLED` environment variable to `true` by editing the `MyLambda` scheme under `Run`.
* Switch to the `MyLambda` scheme and select the "My Mac" destination
* Set the `LOCAL_LAMBDA_SERVER_ENABLED` environment variable to `true` by editing the `MyLambda` scheme Run/Arguments options.
* Hit `Run`
* Once it is up you should see a log message in the Xcode console saying
`LocalLambdaServer started and listening on 127.0.0.1:7000, receiving events on /invoke`
Expand Down