Skip to content

Commit

Permalink
docs: add info about env var validation to readme (#17)
Browse files Browse the repository at this point in the history
this pr adds documentation about the `ENV_VALIDATION` environment
variable, which controls environment variable validation, to the readme.
  • Loading branch information
stefanprobst authored Feb 5, 2025
2 parents fb685d9 + 2a79328 commit 026a500
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,13 @@ the default template accepts the following variables:
client-side analytics with matomo.
- `NEXT_PUBLIC_GOOGLE_SITE_VERIFICATION` (optional): set this to verify site ownership for google
search console.
- `ENV_VALIDATION` (optional): whether to validate environment variables. supported values are
"disabled", "enabled", and "public". defaults to "enabled". "public" only validates build-args
prefixed with `NEXT_PUBLIC_`, which can make sense in a docker build context.

when adding new environment variables, don't forget to add them to `.env.local.example` as well.
when adding new environment variables, don't forget to add them to
[`.env.local.example`](./.env.local.example) and [`config/env.config.js`](./config/env.config.js) as
well.

install dependencies:

Expand Down Expand Up @@ -125,7 +130,7 @@ working setup.
orm.

- [`variant/with-commitlint`](https://github.com/acdh-oeaw/template-app-next/tree/variant/with-commitlint)
branch: enables[ `commitlint`](https://commitlint.js.org) and runs it as a git hook, and as part
branch: enables [`commitlint`](https://commitlint.js.org) and runs it as a git hook, and as part
of the validation workflow in a github action.

- [`variant/with-email`](https://github.com/acdh-oeaw/template-app-next/tree/variant/with-email)
Expand All @@ -152,5 +157,5 @@ working setup.
make it easy to activate full i18n support later if needed.

- [`variant/with-storybook`](https://github.com/acdh-oeaw/template-app-next/tree/variant/with-storybook)
branch: adds [storybook](https://storybook.js.org) for building ui components in isolation and
branch: adds [`storybook`](https://storybook.js.org) for building ui components in isolation and
creating component documentation.

0 comments on commit 026a500

Please sign in to comment.