Skip to content

Commit 05fc454

Browse files
authored
Merge pull request netlify#30 from netlify/bcomnes-patch-1
Add a note regarding proxying
2 parents b1f266c + cedb57f commit 05fc454

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,30 @@ http://localhost:9000/hello -> folder/hello.js (must export a handler(event, con
2323

2424
The `build` function will run a single build of the functions in the folder.
2525

26+
### Proxying for local development
27+
28+
When your function is deployed on Netlify, it will be available at `/.netlify/functions/function-name` for any given deploy context. It is advantageous to proxy the `netlify-lambda serve` development server to the same path on your primary development server.
29+
30+
Say you are running `webpack-serve` on port 8080 and `netlify-lambda serve` on port 9000. Mounting `localhost:9000` to `/.netlify/functions/` on your `webpack-serve` server (`localhost:8080/.netlify/functions/`) will closely replicate what the final production environment will look like during development, and will allow you to assume the same function url path in development and in production.
31+
32+
See [netlify/create-react-app-lambda](https://github.com/netlify/create-react-app-lambda/blob/3b5fac5fcbcba0e775b755311d29242f0fc1d68e/package.json#L19) for an example of how to do this.
33+
34+
[Example webpack config](https://github.com/imorente/netlify-functions-example/blob/master/webpack.development.config):
35+
36+
```js
37+
module.exports = {
38+
mode: 'development',
39+
devServer: {
40+
proxy: {
41+
"/.netlify": {
42+
target: "http://localhost:9000",
43+
pathRewrite: {"^/.netlify/functions" : ""}
44+
}
45+
}
46+
}
47+
}
48+
```
49+
2650
## Webpack Configuration
2751

2852
By default the webpack configuration uses `babel-loader` to load all js files. Any `.babelrc` in the directory `netlify-lambda` is run from will be respected. If no `.babelrc` is found, a [few basic settings are used](https://github.com/netlify/netlify-lambda/blob/master/lib/build.js#L11-L15a).

0 commit comments

Comments
 (0)