Skip to content
This repository was archived by the owner on Feb 10, 2025. It is now read-only.

Commit 2805a3b

Browse files
authored
TILA-2692 update project docs (#696)
1 parent d1c8972 commit 2805a3b

3 files changed

Lines changed: 25 additions & 18 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,8 @@
22
- [End user UI](ui/)
33
- [Admin UI](admin-ui/)
44
- [Common UI components](common/)
5+
6+
# Making a release
7+
Draft a new release in https://github.com/City-of-Helsinki/tilavarauspalvelu-ui/releases - `ui` and `admin-ui` pipelines will pick up releases named `release-*`.
8+
9+
Include a changelog if applicable.

ui/.env.local.example

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22
# For NEXTAUTH_SECRET, use: `openssl rand -base64 32`
33
# For OIDC_CLIENT_SECRET, use `openssl rand -hex 32`
44
# Note: Changing a secret may invalidate existing sessions and/or verification tokens
5+
# Other keys/tokens can be found at Azure devops libaray, under "development". Keys have prefix `UI_`
56
# -----------------------
67

7-
NEXT_PUBLIC_BASE_URL=
8-
TILAVARAUS_API_URL=
9-
NEXTAUTH_URL=
8+
NEXT_PUBLIC_BASE_URL=https://local-tilavaraus.hel.fi:3000
9+
TILAVARAUS_API_URL=http://localhost:8000
10+
NEXTAUTH_URL=https://local-tilavaraus.hel.fi:3000/api/auth
1011
NEXTAUTH_SECRET=
11-
NEXT_ENV=
12+
NEXT_ENV=development
1213

13-
DISABLE_AUTH=
14-
NEXT_PUBLIC_MOCK_REQUESTS=
14+
DISABLE_AUTH=false
15+
NEXT_PUBLIC_MOCK_REQUESTS=false
1516
NEXT_PUBLIC_MAPBOX_TOKEN=
1617
NEXT_PUBLIC_SENTRY_DSN=
1718
SENTRY_AUTH_TOKEN=
18-
NEXT_PUBLIC_ENABLE_MATOMO=
19-
TZ=
19+
NEXT_PUBLIC_ENABLE_MATOMO=false
2020

21-
OIDC_CLIENT_ID=
21+
OIDC_CLIENT_ID=tilavaraus-ui-dev
2222
OIDC_CLIENT_SECRET=
23-
OIDC_URL=
24-
OIDC_TOKEN_URL=
25-
OIDC_ACCESS_TOKEN_URL=
26-
OIDC_TILAVARAUS_API_SCOPE=
27-
OIDC_PROFILE_API_SCOPE=
28-
OIDC_SCOPE=
29-
OIDC_CALLBACK_URL=
30-
NEXT_PUBLIC_OIDC_END_SESSION=
23+
OIDC_URL=https://tunnistamo.test.hel.ninja/openid
24+
OIDC_TOKEN_URL=https://tunnistamo.test.hel.ninja/openid/token
25+
OIDC_ACCESS_TOKEN_URL=https://tunnistamo.test.hel.ninja/api-tokens/
26+
OIDC_TILAVARAUS_API_SCOPE=https://api.hel.fi/auth/tilavarausapidev
27+
OIDC_PROFILE_API_SCOPE=https://api.hel.fi/auth/helsinkiprofile
28+
OIDC_SCOPE=openid profile https://api.hel.fi/auth/helsinkiprofile https://api.hel.fi/auth/tilavarausapidev
29+
OIDC_CALLBACK_URL=https://local-tilavaraus.hel.fi:3000/api/auth/callback/
30+
NEXT_PUBLIC_OIDC_END_SESSION=https://tunnistamo.test.hel.ninja/openid/end-session

ui/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
1818
First check out the latest version of the backend/api project from https://github.com/City-of-Helsinki/tilavarauspalvelu-core and change current directory to backend project and start it:
1919

2020
```
21-
docker-compose up --build
21+
docker-compose up backend --build --force-recreate
2222
```
2323

2424
Make sure /etc/hosts point domain local-tilavaraus.hel.fi to 127.0.0.1. This is important because tunnistamo currently does not provide SameSite information for the cookies it uses. Some browsers (like Chrome) default the SameSite to be Lax. Because of this tunnistamo and the site it is authenticating for need to share same-site context. Without fulfilling this requirement the silent renew might not work properly due to browser blocking required cookies.
@@ -113,6 +113,8 @@ You can write handlers for rest and graphql requests in '/mocks/handlers.ts'. Ca
113113

114114
## Configurable environment variables
115115

116+
See `.env.local.example` and Azure DevOps library for values.
117+
116118
| Name | Description |
117119
| ------------------------------ | --------------------------------------------------------------- |
118120
| NEXT_PUBLIC_BASE_URL | application baseUrl |

0 commit comments

Comments
 (0)