https://github.com/geonetwork/geonetwork-ui
GeoNetwork UI is a suite of Applications made to provide a modern facade to your GeoNetwork 4 catalog. It also provides Web Components to embed various parts of your data catalog in third party websites.
https://github.com/geonetwork/geonetwork-ui
angular data geonetwork gis ui webcomponents
Last synced: 2 months ago
JSON representation
GeoNetwork UI is a suite of Applications made to provide a modern facade to your GeoNetwork 4 catalog. It also provides Web Components to embed various parts of your data catalog in third party websites.
- Host: GitHub
- URL: https://github.com/geonetwork/geonetwork-ui
- Owner: geonetwork
- License: gpl-2.0
- Created: 2020-06-02T07:25:02.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T13:33:17.000Z (3 months ago)
- Last Synced: 2025-04-03T14:23:01.287Z (3 months ago)
- Topics: angular, data, geonetwork, gis, ui, webcomponents
- Language: TypeScript
- Homepage: https://geonetwork.github.io/geonetwork-ui/main/docs/
- Size: 112 MB
- Stars: 74
- Watchers: 15
- Forks: 38
- Open Issues: 80
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Support: support-services/.env
Awesome Lists containing this project
README
   [](https://coveralls.io/github/geonetwork/geonetwork-ui?branch=main)
# 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](https://discourse.osgeo.org/t/about-the-geonetwork-ui-category/59280) 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](https://github.com/geonetwork/geonetwork-ui/discussions).
To learn more about the project, visit the [GeoNetwork-UI website](https://geonetwork.github.io/geonetwork-ui/main/docs/)
## Getting started
Install first GeoNetwork 4 [from source](https://geonetwork-opensource.org/manuals/4.0.x/eng/users/install-guide/installing-from-source-code.html#building-running)
or using [docker](https://github.com/geonetwork/docker-geonetwork/tree/master/4.0.1).
Install [Node](https://nodejs.org/): using an LTS is recommended, the minimum required version is 14.17.0. Using [nvm](https://github.com/nvm-sh/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](CONTRIBUTING.md) explains the structure of the project and how to work with it.
If you would like to contribute code, please follow our [style guide](STYLEGUIDE.md).
[Storybook](https://storybook.js.org) 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](https://geonetwork.github.io/geonetwork-ui/main/storybook/demo/)
- [Metadata Converter app](https://geonetwork.github.io/geonetwork-ui/main/apps/metadata-converter/)
- [Web Components demo](https://geonetwork.github.io/geonetwork-ui/main/demo/webcomponents/)
## More information
### Running GeoNetwork UI applications
To run a specific application using a development server, use:
```shell script
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](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](proxy-config.js) file like so:
```diff
@@ -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:
```shell script
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
```shell script
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 :
```shell script
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 :
```shell script
npx nx e2e (app_name)
```