This recipe should work for most mainstream OSs, including Windows, Mac and mainstream Linux distros.
-
You need the client id in order to run the application. Log onto portal.azure.com and find it under the Kravbank application.
-
Create (or copy from someone else in the team) a .env.local file in krb-webclient directory with the following lines:
REACT_APP_API_URL=https://krb-api-man-dev.azure-api.net REACT_APP_CLIENTID="" REACT_APP_APPLICATION_INSIGHTS_ENVIRONMENT=localhost REACT_APP_APPLICATION_INSIGHTS_CONNECTION_STRING=""
-
Install Volta if it isn't already installed, see https://docs.volta.sh/guide/getting-started for a short how to. ( This only needs to be done once, afterwards it can be reused for every project.)
-
Make sure you have added a SSH key to your GitHub settings to be able to clone the repository securely.
-
Clone the repository:
git clone git@github.com:dfo-no/krb-webclient.git
-
Navigate to the project root directory, and install packages:
npm install
-
Install ESLint, Prettier, and SonarLint extensions.
-
Launch the project:
npm start
Every time new commits are pushed to GitHub a GitHub Action is triggered that runs the latest Cypress tests from the branch. This workflow is configured in .github/workflows/cypress-tests-on-krb-branches.yaml
You can find the results here: https://github.com/dfo-no/krb-webclient/actions
To run the tests locally, run npx cypress open. This will open a dialog like this:
After choosing E2E, select which browser to use:
And then what test to run:
Once the test has run it will run automatically most of the time every time something changes.
If a test doesn't work and there isn't an obvious reason, sometimes it might help to just restart the test.
This holds true both locally as well as well as in GitHub Actions.
To restart it in GitHub Actions, go to https://github.com/dfo-no/krb-webclient/actions, open the failed job:
... and restart just the job (i.e. part of the workflow) that failed:
Keycloak is the OpenID Connect (OIDC) - an authentication and authorization protocol. We're using it as an identity and Access Management (IAM) tool for kravbank. To simplify and secure the process of requesting access from the Keycloak server, we're using react-oidc as a service worker.
The OidcConfiguration uses the frontend client id, within the keycloak kravbank realm.
Keycloak is live at https://krb-backend-auth.azurewebsites.net
Log in to the administration console to manage users, roles, realm settings, client settings and more.
Read more from Kravbank confluence, keycloak docs and react-oidc repo: https://dfo-no.atlassian.net/wiki/spaces/KRB/pages/2562654209/Keycloak https://www.keycloak.org/docs/latest/securing_apps/index.html https://github.com/AxaGuilDEv/react-oidc