GeoNetwork UI

GeoNetwork-UI provides several applications to improve the user experience of your GeoNetwork catalog.

It also provides Web Components to embed various parts of your data catalog in third party websites.

End users are invited to join us on the GeoNetwork-UI forum on OsGeo Discourse: https://discourse.osgeo.org/c/geonetwork/ui

Developers should check out the GitHub discussions.

To learn more about the project, visit the GeoNetwork-UI website

Getting started

Install first GeoNetwork 4 from source or using docker.

Install Node: using an LTS is recommended, the minimum required version is 14.17.0. Using nvm makes this much simpler.

Run npm install to fetch all dependencies of the project.

Run npm start to start the datahub app in a dev server.

Once started the application is available at http://localhost:4200/.

The contributing guide explains the structure of the project and how to work with it.

If you would like to contribute code, please follow our style guide.

Storybook is a tool for exploring individual features of the application in an interactive way. You can start it with npm run storybook.

Live demo

You can either try complete applications or showcases of components using the following links:

• Storybook of UI components
• Metadata Converter app
• Web Components demo

More information

Running GeoNetwork UI applications

To run a specific application using a development server, use:

npx nx serve (app_name)

And navigate to http://localhost:4200/.

If you're using the standard dev configuration then you should head to the support-services folder and run docker compose up -d to have the required support services running locally (such as GeoNetwork).

Otherwise, you can adjust the GeoNetwork instance used as a backend in the proxy-config.js file like so:

@@ -1,6 +1,6 @@
 module.exports = {
   '/geonetwork': {
-    target: 'http://localhost:8080',
+    target: 'https://my.catalogue.org',
     secure: true,

Build GeoNetwork-UI applications

To build a specific application, use:

npx nx build (app_name)

The build artifacts will be stored in the dist/ directory. Note: this always produces a production build.

Tests

Unit tests

Run npm test to execute the affected unit tests via Jest. Affected code is compared to origin/main.

You can test

• affected code
• all modules
• specific lib or app
• specific test suite

npm run test
npm run test:all
npx nx test (lib_name)
npx nx test --test-match=/data/dev/gn/ui/libs/common/src/lib/services/bootstrap.service.spec.ts

End-to-end-tests

To run the tests with the interface:

Start docker from 'support-services', and then in the project root folder :

npx nx e2e (app_name) --watch

Then select the file(s) you want to test in the interface.

To run the tests without interface :

Start docker from 'support-services', and then in the project root folder :

--> ALl tests :

npx nx e2e  (app_name)

Project structure

The GeoNetwork UI project was generated using Nx and is composed of:

• libraries containing components and services in the libs folder
• applications using said components in the apps folder
• web components using also said components in the apps/webcomponents folder

Other directories include:

• conf: configuration-related files
• translations: contains the translations of all keys used in GeoNetwork UI
• tools: various tools & utils for docker, internationalization etc.

Libraries

Libraries are organized in the following fashion:

1. Presentation libraries are in the ui folder and are categorized by their forms:

   • ui-inputs for reusable components made to collect input from the user (e.g.: form fields, buttons...)
   • ui-elements for components focused on rendering specific types of information in an elaborate way, which may or may not be related to business usages; examples include download links, facet or selection tree, etc.
   • ui-layout for components which occupy a large part of the screen and might contain variable content or other components
   • ui-map for map-specific components (map container, controls, etc.)
   • ui-widgets for reusable, small, self-contained components which show information in a visual way, similar to icons but more elaborate (e.g.: icon with tooltip, status indicator, progress bar...)

   Note: presentation components contain mainly HTML and CSS code, and should contain very little logic

2. Libraries providing business or data logic and state management are in the feature folder and are categorized by their intended use:

   • feature-auth for logic and components related to authentication
   • feature-catalog for logic and components related to general catalog topics (title, logo, etc.)
   • feature-dataviz for logic and components related to data visualization
   • feature-record for logic and components related to displaying a catalog record's information (metadata, data preview, exports, APIs...)
   • feature-editor for logic and components related to editing metadata
   • feature-map for logic and components related to interactive maps
   • feature-search for logic and components related to searching through the catalog
   • feature-notifications for notifications systems

   Note: these libraries provide "smart components" which are communicating with each other using a NgRx store.
   They rely on presentation components and as such hold very little HTML or CSS code.

3. Libraries used for interacting with backend services are in the data-access folder:

   • data-access-gn4 contains an auto-generated API client for the GeoNetwork 4 backend
   • data-access-datafeeder contains an auto-generated API client for the Datafeeder backend

4. Libraries providing various utilities in the util folder:

   • util-data-fetcher for fetching and querying datasets
   • util-app-config for parsing and validating application configurations
   • util-shared for shared models and types, test fixtures, app-wide settings etc.
   • util-i18n for translation and internationalization

5. Libraries providing common services or shared models are in the util folder:

   • common-domain contains many definitions used across the whole project
   • common-fixtures contains test fixtures

6. Libraries providing low-level functionalities that can be used both in front and backend are in the api folder:

   • api-metadata-converter for providing a pivot metadata model and conversion to interoperable formats

webcomponents: Embeddable webcomponents

See the specific README file.

Application Configuration

GeoNetwork UI provides a standard way of configuring applications using the conf/default.toml file.

This file can be used to:

• customize the URL used to reach the GeoNetwork 4 API
• indicate an optional proxy path to the application
• indicate a metadata language to be used when searching
• customize the theme used in the application (colors, fonts...)
• define custom translations for the different languages

Please refer to the embedded comments in the file for more information.

Note: as of now, only the Datahub application relies on this file

Important: In order for the search to be efficient, please indicate the metadata_language of the queried catalog.

Internationalization

Every label visible to the user in the different applications must be translated. All labels are identified using keys, for example:

• table.object.count
• results.layout.selectOne
• datafeeder.summarizePage.illustration
• catalog.title.welcome.html

A repository of all translations is available in the translations folder. These are the translations used in the different applications of the geonetwork-ui project.

Please note that only the translations whose key end in .html can accept HTML markup.

To document

How to build and run web components

• Explain unit test setup & architecture with jest