rsnext/examples/with-universal-configuration-runtime/README.md
Joe Haddad 7d038dfef1
Suggest npx over npm init (#13637)
This updates old examples to the more universal `npx` command.

Fixes https://github.com/vercel/next.js/discussions/12103
2020-06-01 17:36:57 +00:00

1.3 KiB

With universal runtime configuration

This example show how to set custom environment variables for your application at runtime using the publicRuntimeConfig key in next.config.js

For documentation see: https://github.com/vercel/next.js#exposing-configuration-to-the-server--client-side

How to use

Using create-next-app

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

npx create-next-app --example with-universal-configuration-runtime with-universal-configuration-runtime-app
# or
yarn create next-app --example with-universal-configuration-runtime with-universal-configuration-runtime-app

Download manually

Download the example:

curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-universal-configuration-runtime
cd with-universal-configuration-runtime

Install it and run:

npm install
API_URL='https://example.com' npm run dev
# or
yarn
API_URL='https://example.com' yarn dev

Deploy it to the cloud with Vercel (Documentation).