Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.67 KB

development.md

File metadata and controls

44 lines (31 loc) · 2.67 KB
Raw

Development

This file contains info for contributors to the Record Manager UI codebase.

Running in Development Mode

To configure the application use Setup Guide. To run the application in development mode use npm run dev. By default, the application is accessible from http://localhost:3000.

Running with Dockerized Services and Internal Authorization

This section describes the development scenario when developer uses dockerized services with internal authorization to develop. All the services, including dockerized record-manager-ui, run by default at URL starting with http://localhost:1235/record-manager. To attach simultaneously frontend for the development use setup from .env.internal-auth, e.g., by running ln -s .env.internal-auth .env; npm run dev.

Running with Dockerized Services and Keycloak Authorization

This section describes the development scenario when developer uses dockerized services with keycloak authorization to develop. All the services, including dockerized record-manager-ui, run by default at URL starting with http://localhost:1235/record-manager. To attach simultaneously frontend for the development use setup from .env.keyclaok-auth, e.g., by running ln -s .env.keycloak-auth .env; npm run dev.

npm run dev starts developement version of record-manager-ui at http://localhost:3000. In order to login to through keycloak record-manager realm needs to be configured: open the record-manager realm, under Clients open the record-manager client and set Valid redirect URIs (by default it should be http://localhost:3000/*) and Web Origins (by default it should be http://localhost:3000).

Running with all Services in Development Mode

This section describes the development scenario when the developer runs all dependent services in development mode. By default, Record Manager UI runs at http://localhost:3000 while Record Manager Server runs at different port. This requires setting up the CORS policy of the server appropriately, i.e., configuring config.properties to contain security.sameSite=None and set up also cors.allowedOrigin if needed.

Adding Configuration Parameters

When runtime configuration parameters are added to the application, they also need to be added to Docker processing so that environment variables can be used to set the variables. The following needs to be done:

  1. Add the parameters to .docker/config.js.template
  2. Add the parameters to environment substitution in .docker/docker-entrypoint.sh
  3. Add the parameters to .env.example