rsnext/examples/with-dotenv
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
..
pages Update Examples for Fast Refresh (#13068) 2020-05-18 17:44:18 -04:00
.env Update dotenv example (#9372) 2019-11-10 19:45:12 -08:00
next.config.js Update dotenv example (#9372) 2019-11-10 19:45:12 -08:00
package.json Update dotenv example (#9372) 2019-11-10 19:45:12 -08:00
README.md Suggest npx over npm init (#13637) 2020-06-01 17:36:57 +00:00

With Dotenv example

This example shows how to inline env vars.

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

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-dotenv with-dotenv-app
# or
yarn create next-app --example with-dotenv with-dotenv-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-dotenv
cd with-dotenv

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).

Note

  • It is a bad practice to commit env vars to a repository. Thats why you should normally gitignore your .env file.
  • In this example, as soon as you reference an env var in your code, it will automatically be made publicly available and exposed to the client.
  • If you want to have more centralized control of what is exposed to the client check out the example with-universal-configuration-build-time.
  • Env vars are set (inlined) at build time. If you need to configure your app at runtime, check out examples/with-universal-configuration-runtime.