Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update frontend readme variables #356

Merged
merged 8 commits into from
May 20, 2024
Merged

update frontend readme variables #356

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2d88634
added table to frontend readme
Gerwoud May 4, 2024
c01e755
added .env vars to the README
Gerwoud May 13, 2024
13c9296
Merge branch 'development' into frontend/docutation/readme-update
Gerwoud May 13, 2024
d0a5e20
updated readme
Gerwoud May 17, 2024
119240a
changed URL of api part
Gerwoud May 20, 2024
4de5e14
Merge branch 'development' into frontend/docutation/readme-update
Gerwoud May 20, 2024
406f3e9
removed code verfier
Gerwoud May 20, 2024
9bce9ca
Merge branch 'frontend/docutation/readme-update' of github.com:SELab-…
Gerwoud May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,21 @@ You can choose your own preferred webserver like for example `nginx`, `serve` or
npm run dev
```

## Setting up the environment variables

The project requires a couple of environment variables to run, if you want to develop on this codebase.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't really know what the if you want to develop on this codebase does here, it always needs environment variables to run?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, not project, but application

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d0a5e20

Setting values for these variables can be done with a method to your own liking.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, but maybe explain how we do it so they can use that, and are you sure this can be done with a method to their liking? 'Cause our code always works with a .env file or docker env variables right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line in general is not necessary

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d0a5e20


| Variable | Description |
|-------------------|--------------------------------------------------------------------------|
| VITE_API_HOST | Url where the api is located |
| VITE_APP_TENANT_ID | [Tenant id](https://learn.microsoft.com/nl-nl/entra/fundamentals/whatis) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this spacing consistent

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d0a5e20

| VITE_APP_CLIENT_ID | [Client id](https://learn.microsoft.com/nl-nl/entra/identity-platform/v2-protocols) |
| VITE_APP_CODE_VERIFIER | Verifier code | |

If you want more information regarding the .env variables please refer to the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.env -> environment

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also they can only go to the docs for the 2 variables to which you already provided a link to, so juist remove this comment

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d0a5e20

[Microsoft docs](https://learn.microsoft.com/en-us/entra/)

## Maintaining the codebase
### Writing tests
When writing new code it is important to maintain the right functionality so
Expand Down