Add instructions on how to use with serverless-offline #104
Add instructions on how to use with serverless-offline
Adding a brief instructional section on how to use this plugin with serverless-offilne. I had to dig around a while to discover that you need the --location flag.
- Loading branch information
commit 18cf0b436c02ccef88aa1239ae1cecc2f5dcc560
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -118,6 +118,21 @@ The normal Serverless deploy procedure will automatically bundle with Webpack: | |
| - Install Serverless Webpack as above | ||
| - Deploy with `serverless deploy` | ||
|
|
||
| ### Use with serverless-offline | ||
|
|
||
| - Put the serverless-webpack plugin before the serverless-offline plugin in your configuration file. | ||
| ```yaml | ||
| plugins: | ||
| - serverless-webpack | ||
| - serverless-offline | ||
| ``` | ||
|
|
||
| - Let serverless-offline know where the bundles are built | ||
| ``` | ||
| > serverless offline start --location .webpack | ||
|
Member
There was a problem hiding this comment. This command line will work as soon as #131 is merged. |
||
| ``` | ||
|
|
||
|
|
||
| ### Simulate API Gateway locally | ||
|
|
||
| To start a local server that will act like the API Gateway use the following command. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps change to 'Usage'?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will change it accordingly and also add the
--locationhint (as long as I'm allowed to do that). Otherwise I open a separate PR with the same changes (as they are trivial) and close this one to get 2.0.0 out later.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hassankhan Just saw, that we have 2 sections for serverless-offline. This one and one under "Simulate API Gateway locally". I will combine the two into this one (as we plan to remove serve) and commit that. Then we can just remove the whole "Simulate ..." section together with the serve implementation later.