From f366e51ce807c598543b82dba3bc8d49b3cb1eff Mon Sep 17 00:00:00 2001 From: Gerwoud Van den Eynden <62761483+Gerwoud@users.noreply.github.com> Date: Mon, 20 May 2024 12:50:17 +0200 Subject: [PATCH] update frontend readme variables (#356) * added table to frontend readme * added .env vars to the README * updated readme * changed URL of api part * removed code verfier --- frontend/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/frontend/README.md b/frontend/README.md index a1ef1856..b2c30576 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -26,6 +26,17 @@ You can choose your own preferred webserver like for example `nginx`, `serve` or npm run dev ``` +## Setting up the environment variables + +This application requires a couple of environment variables to run. +Setting values for these variables can be done with a method to your own liking. + +| Variable | Description | +|------------------------|------------------------------------------------------------------------------------| +| VITE_API_HOST | URL of the API | +| VITE_APP_TENANT_ID | [Tenant id](https://learn.microsoft.com/nl-nl/entra/fundamentals/whatis) | +| VITE_APP_CLIENT_ID | [Client id](https://learn.microsoft.com/nl-nl/entra/identity-platform/v2-protocols) | + ## Maintaining the codebase ### Writing tests When writing new code it is important to maintain the right functionality so