Merge branch 'master' of https://github.com/netlify/create-react-app-lambda

sw-yx · sw-yx · commit 70ef615cebd2 · 2019-01-10T10:47:56.000-08:00
diff --git a/README.md b/README.md
@@ -6,6 +6,10 @@ As an example, we've included a small `src/lambda/hello.js` function, which will
 
 [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/create-react-app-lambda)
 
+## Video
+
+Learn how to set this up yourself (and why everything is the way it is) from scratch in a video: https://www.youtube.com/watch?v=3ldSM98nCHI 
+
 ## Babel/webpack compilation
 
 All functions are compiled with webpack using the Babel Loader, so you can use modern JavaScript, import npm modules, etc., without any extra setup.
@@ -50,9 +54,11 @@ This will start the normal create-react-app dev server and open your app at `htt
 
 Local in-app requests to the relative path `/.netlify/functions/*` will automatically be proxied to the local functions dev server.
 
+## Typescript
+
 <details>
   <summary>
-    <b id="typescript">Typescript</b>
+    <b id="typescript">Click for instructions</b>
   </summary>
 You can use Typescript in both your React code (with `react-scripts` v2.1+) and your lambda functions )with `netlify-lambda` v1.1+). Follow these instructions:
 
@@ -61,18 +67,24 @@ You can use Typescript in both your React code (with `react-scripts` v2.1+) and
 3. use types in your event handler:
 
 ```ts
-import { Handler, Context, Callback } from 'aws-lambda';
+import { Handler, Context, Callback, APIGatewayEvent } from 'aws-lambda';
 
 interface HelloResponse {
   statusCode: number;
   body: string;
 }
 
-const handler: Handler = (event: any, context: Context, callback: Callback) => {
+const handler: Handler = (
+  event: APIGatewayEvent,
+  context: Context,
+  callback: Callback
+) => {
+  const params = event.queryStringParameters;
   const response: HelloResponse = {
     statusCode: 200,
     body: JSON.stringify({
-      msg: `Hello world ${Math.floor(Math.random() * 10)}`
+      msg: `Hello world ${Math.floor(Math.random() * 10)}`,
+      params
     })
   };
 
@@ -88,6 +100,8 @@ You are free to set up your `tsconfig.json` and `tslint` as you see fit.
 
 </details>
 
+**If you want to try working in Typescript on the client and lambda side**: There are a bunch of small setup details to get right. Check https://github.com/sw-yx/create-react-app-lambda-typescript for a working starter.
+
 ## Service Worker
 
 The service worker does not work with lambda functions out of the box. It prevents calling the function and returns the app itself instead ([Read more](https://github.com/facebook/create-react-app/issues/2237#issuecomment-302693219)). To solve this you have to eject and enhance the service worker configuration in the webpack config. Whitelist the path of your lambda function and you are good to go.
diff --git a/netlify.toml b/netlify.toml
@@ -1,4 +1,4 @@
 [build]
-  Command = "yarn build"
-  Functions = "lambda"
-  Publish = "build"
+  command = "yarn build"
+  functions = "lambda"
+  publish = "build"
