Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanprobst committed Feb 2, 2025
1 parent d293ae7 commit c8175fd
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ cp .env.local.example .env.local

also, set environment variables required by [validation](./.github/workflows/validate.yml) and
[deployment](./.github/workflows/build-deploy.yml) github actions. use
["variables"](https://github.com/acdh-oeaw/template-app-next/settings/variables/actions) for every
["variables"](https://github.com/acdh-oeaw/viecpro-nuxt/settings/variables/actions) for every
environment variable prefixed with `NEXT_PUBLIC_`, and
["secrets"](https://github.com/acdh-oeaw/template-app-next/settings/secrets/actions) for all others.

the default template accepts the following variables:
["secrets"](https://github.com/acdh-oeaw/viecpro-nuxt/settings/secrets/actions) for all others.

- `NEXT_PUBLIC_REDMINE_ID` (required): service issue for this application in the acdh-ch
[redmine](https://redmine.acdh.oeaw.ac.at) issue tracker.
Expand All @@ -37,8 +35,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.ts`](./config/env.config.ts) as
well.

install dependencies:

Expand All @@ -54,7 +57,7 @@ pnpm run dev

> [!TIP]
>
> this template supports developing in containers. when opening the project in your editor, you
> this repository supports developing in containers. when opening the project in your editor, you
> should be prompted to re-open it in a devcontainer.
## how to test
Expand All @@ -66,8 +69,8 @@ pnpm run build
pnpm run test:e2e
```

visual snapshot tests should be run in the template's devcontainer - or a comparable debian bookworm
based linux environment -, and can be updated with:
visual snapshot tests should be run in the repository's devcontainer - or a comparable debian
bookworm based linux environment -, and can be updated with:

```bash
pnpm run test:e2e:update-snapshots
Expand Down

0 comments on commit c8175fd

Please sign in to comment.