Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/netlify/create-react-app-lambda


https://github.com/netlify/create-react-app-lambda

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
## Create-React-App-Lambda



This project is a reference demo showing you how to use [Create React App v3](https://github.com/facebookincubator/create-react-app) and [netlify-lambda v1](https://github.com/netlify/netlify-lambda) together in a [Netlify Dev](https://www.netlify.com/docs/cli/?utm_source=github&utm_medium=swyx-CRAL&utm_campaign=devex#netlify-dev-beta) 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:



[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg?utm_source=github&utm_medium=swyx-CRAL&utm_campaign=devex)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/create-react-app-lambda&utm_source=github&utm_medium=swyx-CRAL&utm_campaign=devex)



> ⚠️NOTE: You may not need this project at all. [Netlify Dev](https://github.com/netlify/netlify-dev-plugin) works with `create-react-app` out of the box! Only use `netlify-lambda` if you need a build step for your functions, eg if you want to use Babel or TypeScript ([see its README for details](https://github.com/netlify/netlify-lambda/blob/master/README.md#netlify-lambda)).



## Project Setup



**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`](https://www.netlify.com/docs/netlify-toml-reference/?utm_source=github&utm_medium=swyx-CRAL&utm_campaign=devex).



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`.



## 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 (inside `src/lambda`) are compiled with webpack using Babel, so you can use modern JavaScript, import npm modules, etc., without any extra setup.



## Local Development



```bash

## 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 functions

```



This fires up [Netlify Dev](https://www.netlify.com/docs/cli/?utm_source=github&utm_medium=swyx-CRAL&utm_campaign=devex#netlify-dev-beta), which:



- Detects that you are running a `create-react-app` project and runs the npm script that contains `react-scripts start`, which in this project is the `start` script

- Detects that you use `netlify-lambda` as a [function builder](https://github.com/netlify/netlify-dev-plugin/#function-builders-function-builder-detection-and-relationship-with-netlify-lambda), and runs the npm script that contains `netlify-lambda build`, which in this project is the `build:lambda` script.



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/hello` and 

- `http://localhost:8888/.netlify/functions/async-dadjoke`



## Deployment



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`).



## Typescript



  

    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:



1. `yarn add -D typescript @types/node @types/react @types/react-dom @babel/preset-typescript @types/aws-lambda`

2. convert `src/lambda/hello.js` to `src/lambda/hello.ts`

3. use types in your event handler:



```ts

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.



## Routing and authentication with Netlify Identity



For a full demo of routing and authentication, check this branch: https://github.com/netlify/create-react-app-lambda/pull/18 This example will not be maintained but may be helpful.



## Service Worker



`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](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.