This project is a reference demo showing you how to use Create React App v3 and netlify-lambda v1 together in a Netlify Dev workflow. You can clone this and immediately be productive with a React app with serverless Netlify Functions in the same repo. Alternatively you can deploy straight to Netlify with this one-click Deploy:
⚠️ NOTE: You may not need this project at all. Netlify Dev works withcreate-react-appout of the box! Only usenetlify-lambdaif you need a build step for your functions, eg if you want to use Babel or TypeScript (see its README for details).
Source: The main addition to base Create-React-App is a new folder: src/lambda. This folder is specified and can be changed in the package.json script: "build:lambda": "netlify-lambda build src/lambda".
Dist: Each JavaScript file in there will be built for Netlify Function deployment in /built-lambda, specified in netlify.toml.
As an example, we've included a small src/lambda/hello.js function, which will be deployed to /.netlify/functions/hello. We've also included an async lambda example using async/await syntax in async-dadjoke.js.
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
All functions (inside src/lambda) are compiled with webpack using Babel, so you can use modern JavaScript, import npm modules, etc., without any extra setup.
## prep steps for first time users
npm i -g netlify-cli # Make sure you have the [Netlify CLI](https://github.com/netlify/cli) installed
git clone https://github.com/netlify/create-react-app-lambda ## clone this repo
cd create-react-app-lambda ## change into this repo
yarn # install all dependencies
## done every time you start up this project
ntl dev ## nice shortcut for `netlify dev`, starts up create-react-app AND a local Node.js server for your Netlify functionsThis fires up Netlify Dev, which:
- Detects that you are running a
create-react-appproject and runs the npm script that containsreact-scripts start, which in this project is thestartscript - Detects that you use
netlify-lambdaas a function builder, and runs the npm script that containsnetlify-lambda build, which in this project is thebuild:lambdascript.
You can view the project locally via Netlify Dev, via localhost:8888.
Each function will be available at the same port as well:
http://localhost:8888/.netlify/functions/helloandhttp://localhost:8888/.netlify/functions/async-dadjoke
During deployment, this project is configured, inside netlify.toml to run the build command: yarn build.
yarn build corresponds to the npm script build, which uses npm-run-all (aka run-p) to concurrently run "build:app" (aka react-scripts build) and build:lambda (aka netlify-lambda build src/lambda).
Click for instructions
You can use Typescript in both your frontend React code (with react-scripts v2.1+) and your serverless functions (with netlify-lambda v1.1+). Follow these instructions:
yarn add -D typescript @types/node @types/react @types/react-dom @babel/preset-typescript @types/aws-lambda- convert
src/lambda/hello.jstosrc/lambda/hello.ts - use types in your event handler:
import { Handler, Context, Callback, APIGatewayEvent } from 'aws-lambda'
interface HelloResponse {
statusCode: number
body: string
}
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)}`,
params,
}),
}
callback(undefined, response)
}
export { handler }rerun and see it work!
You are free to set up your tsconfig.json and tslint as you see fit.
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.
For a full demo of routing and authentication, check this branch: #18 This example will not be maintained but may be helpful.
create-react-app's default service worker (in src/index.js) does not work with lambda functions out of the box. It prevents calling the function and returns the app itself instead (Read more). 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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent