rsnext/examples/with-dotenv
Shu Uesugi 6804039e94 Make example READMEs more consistent (#10124)
* npx create → npm init

* Fix inconsistent instructions

* Update amp-first

* Update with-graphql-react

* with-firebase-cloud-messaging

* Update with-higher-order-component

* change create-next-app url

* Update create-next-app instruction

* Update instructions to use npm instead of npx

* Move "the idea behind the example" to top

* Rename

* Rename

* Update contributing.md with a README template
2020-01-16 23:23:56 +01:00
..
pages Update dotenv example (#9372) 2019-11-10 19:45:12 -08: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 Make example READMEs more consistent (#10124) 2020-01-16 23:23:56 +01:00

With Dotenv example

This example shows how to inline env vars.

Deploy your own

Deploy the example using ZEIT Now:

Deploy with ZEIT Now

How to use

Using create-next-app

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

npm init 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/zeit/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 now (download):

now

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.