city-of-helsinki / kaavapino-ui

UI for editing city planning projects in Kaavapino API

kaavapino-ui

UI for editing city planning projects in Kaavapino API

How to run

Before running, make sure that you have created a .env file to the project root with the following environmental variables: REACT_APP_OPENID_CONNECT_CLIENT_ID=X REACT_APP_OPENID_AUDIENCE=X REACT_APP_BASE_URL=X (only needed in production, locally uses proxy, which is defined in package.json) REACT_APP_SENTRY_URL=X (only needed in production) 'REACT_APP_ENVIRONMENT=X' (production, development, testing, staging) 'REACT_APP_OPENID_ENDPOINT=X'

1. yarn install
2. yarn start

Developing with fake login (tmporary solution)

To generate token:

• fire up backend
• run in api-directory for your username and email

docker-compose -f ./docker-compose.yml exec api ./manage.py createsuperuser

If not working try (Windows):

docker exec -it kaavapino-api /bin/bash
python ./manage.py createsuperuser

• add token for the same username

docker-compose -f ./docker-compose.yml exec api ./manage.py create_api_token <username>

If not working try (Windows):

docker exec -it kaavapino-api /bin/bash
python ./manage.py create_api_token <user>

• Add generated token to frontend .env as REACT_APP_API_TOKEN

Generating api data

• fire up backend
• copy päivittyvä_Kaavaprojektitiedot.xls to api directory (see Teams)
• run in api directory

docker-compose -f ./docker-compose.yml exec api ./manage.py import_attributes päivittyvä_Kaavaprojektitiedot.xlsx

If not working try (Windows):

docker exec -it kaavapino-api /bin/bash
python manage.py import_attributes päivittyvä_Kaavaprojektitiedot.xlsx

Deploy staging

Install kubectl locally. Check version and run:

#> pwd
... kaavapino/web/deploy/rancher
#> ./deploy_staging_web.sh web:<version> run

kaavapino-ui's Issues

OpenID provider URL should be configurable

kaavapino-ui/src/utils/userManager.js

Line 14 in a3ec8de

authority: 'https://api.hel.fi/sso/openid/',

kaavapino-ui/src/sagas/apiSaga.js

Line 54 in a3ec8de

const data = yield apiUtils.get('https://api.hel.fi/sso/api-tokens/')

Please make these configurable as REACT_APP_OPENID_ENDPOINT. The URL part 'https://api.hel.fi/sso' should be taken from the env var. Rest should stay hardcoded ('/openid/' and '/api-tokens' respectively).

Consider reading environment variables at runtime

Currently environment variables are baked into the bundle (or so I assume, given that they need to be present during build).
Consider writing them into window like so:
https://create-react-app.dev/docs/title-and-meta-tags#injecting-data-from-the-server-into-the-page

We can then replace them just before starting the web server.