UI Dev/QA Environments

DRAFT

QA Environments

Repositories

The Eureka project touches several repositories which allow us to interact with Kong and Keycloak backend (instead of Okapi). If changes are not merged to master, the main branch(es) to reference are below each repository.

Local Dev

  • To set up a developer machine for Eureka UI components, first set up a workspace using the commands stripes inventory --fetch and then stripes workspace (note: requires Stripes CLI to be installed). Select the following components:

    • platform-complete

    • stripes-core

    • ui-authorization-policies

    • ui-authorization-roles

    • ui-plugin-select-application

    • ui-users

  • Switch the following repositories from master to keycloak-ramsons branch:

    • stripes-core

    • ui-users

  • Switch platform-complete from master to snapshot.

  • From base /stripes directory, run yarn install.

  • In /platform-complete directory, create stripes.config.js file and paste the following values:

    • diku2 environment:

      module.exports = { okapi: { // application gateway 'url': 'https://kong-evrk2.int.aws.folio.org', 'uiUrl': 'http://localhost:3000', // authentication details: url, secret, clientId 'authnUrl': 'https://keycloak-evrk2.int.aws.folio.org', 'clientId': 'diku2-application', 'tenant': 'diku2', }, config: { idleSessionWarningSeconds: 10, useSecureTokens: true, logCategories: 'core,path,action,xhr', logPrefix: '--', maxUnpagedResourceCount: 2000, showPerms: false, isSingleTenant: true, tenantOptions: { diku2: { name: 'diku2', clientId: 'diku2-application' } } }, modules: { '@folio/authorization-policies': {}, '@folio/authorization-roles': {}, '@folio/developer' : {}, '@folio/myprofile' : {}, '@folio/plugin-find-user' : {}, '@folio/plugin-select-application' : {}, '@folio/stripes-erm-components' : {}, '@folio/users' : {} }, branding: { logo: { src: './tenant-assets/opentown-libraries-logo.png', alt: 'Opentown Libraries', }, favicon: { src: './tenant-assets/folio-favicon.png', }, }, };
  • Finally, from /platform-complete directory, run yarn stripes serve stripes.config.js to start dev server.