rsnext/examples/custom-routes-proxying/README.md

Custom Routes Proxying Example

This example shows the most basic example using Next.js' new custom routes feature to proxy requests to an upstream server. We have 3 pages: pages/index.js, pages/about.js, and pages/hello/[slug].js. All of these pages will be matched against Next.js and any other path will be proxied to the upstream server.

This approach is very helpful when you are trying to incrementally migrate your application to Next.js but still need to fallback to an existing application. You can add pages to your Next.js application one-by-one and then for non-migrated pages Next.js can proxy to the existing application until they are able to be migrated.

Preview

Preview the example live on StackBlitz:

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example custom-routes-proxying custom-routes-proxying-app
# or
yarn create next-app --example custom-routes-proxying custom-routes-proxying-app

Step 4. Run Next.js in development mode

npm install
npm run dev

# or

yarn install
yarn dev

Test out visiting one of the Next.js pages https://localhost:3000/ and then a non-Next.js page like http://localhost:3000/legacy-first.html or http://localhost:3000/another-legacy.html which will be proxied to the upstream server since it doesn't match any pages/assets in Next.js.

Deploy it to the cloud with Vercel (Documentation). Note: to deploy this example you will need to configure an existing upstream server.