https://github.com/informationgrid/ingrid-editor
Maintain your metadata with ease: create, validate, and publish ISO 19115/19119, OGC and INSPIRE compliant metadata — with simple import & export functionality.
https://github.com/informationgrid/ingrid-editor
angular editor forms kotlin metadata metadata-editor
Last synced: 26 days ago
JSON representation
Maintain your metadata with ease: create, validate, and publish ISO 19115/19119, OGC and INSPIRE compliant metadata — with simple import & export functionality.
- Host: GitHub
- URL: https://github.com/informationgrid/ingrid-editor
- Owner: informationgrid
- License: other
- Created: 2024-01-02T17:08:04.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2026-03-03T14:39:40.000Z (about 1 month ago)
- Last Synced: 2026-03-03T18:51:37.945Z (about 1 month ago)
- Topics: angular, editor, forms, kotlin, metadata, metadata-editor
- Language: Kotlin
- Homepage: https://ingrid-oss.eu/latest/components/ige/
- Size: 44.9 MB
- Stars: 10
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# InGrid Editor
This repository is part of **[InGrid](https://ingrid-oss.eu)**, an open-source solution for building, managing, and exposing metadata-driven information systems.
**About InGrid Editor:**
Maintain your metadata with ease: create, validate, and publish ISO 19115/19119, OGC and INSPIRE compliant metadata — with simple import & export functionality.
[Full documentation](docs/index.adoc)
## Getting started
### Configure the server
The server uses several spring profiles to be configured for different environments.
- dev => used for development, which disables keycloak authentication
- default => also used for development and is set up in `server/src/develop/resources`
- mcloud, ... => profile for customer implementation (import, export, fields, ...)
The profiles can be set in the startup configuration or in the application.properties under `server/src/main/resources`.
We suggest to use the startup configuration to prevent accidentally commit of development changes.
When using Keycloak then some properties must be configured. Please also check `application.properties`:
- spring.security.oauth2.client.provider.keycloak.issuer-uri
- spring.security.oauth2.resourceserver.jwt.issuer-uri
- keycloak.auth-server-url
You also need to configure a user with privileged rights in Keycloak, which is needed for the user management. This can be done by setting
- keycloak.backend-user
- keycloak.backend-user-password
You can also configure it by these environment variables respectively:
- KEYCLOAK_BACKEND_USER
- KEYCLOAK_BACKEND_USER_PASSWORD
#### Database
The application requires a PostgreSQL database instance which is configured in application.properties.
A Docker container to be used in development can be created by running the following command in the `postgres`
directory:
> docker-compose up -d
See also `postgres/.env` for further configuration.
You need to manually create an empty database with the name 'ige' .
The database gets initialized on startup. Afterward you can map your db data directory in the docker-compose file to
make it persistent.
### Start the client and server
For IntelliJ configuration see the section below.
#### Server
You can also run the server from command line:
> ./gradlew bootRun --args='--spring.profiles.active=dev,mcloud,uvp,ingrid,elasticsearch'
With the following command a jar is generated, which contains the whole server including
optimized frontend application:
> ./gradlew -PbuildProfile=prod clean build
#### Client
Install dependencies: `yarn`
For the client just run `npm start` in the frontend directory. When developing for Internet Explorer please
run `npm run start-ie11`.
### Setup IntelliJ IDEA
- Open IntelliJ
- Import project
- _If first project in IntelliJ_ Open or Import > Select `build.gradle` > Open as Project > OK
- _Else_ File > New > Project from Existing Sources... > Select `build.gradle` > OK
- Create **server run configuration**
- **Java 17 SDK** is required
- Run > Edit Configurations > Add New Configuration > Kotlin, and apply the following step by step:
- Name: IgeServerKt
- VM options: `-Dspring.profiles.active=dev,mcloud,uvp,ingrid,elasticsearch`
- Use classpath of module: `ige-ng.server.main`
- Main class: `de.ingrid.igeserver.IgeServerKt`
(The file should automatically appear in the search dialog. When not, choose manually _
server/src/main/java/de/ingrid/igeserver/IgeServer.kt_)
- JRE: `path/to/java-17-jdk`
- Shorten command line: `JAR manifest`
- Install **frontend packages**
- Open a shell in root directory of the project
- Install _yarn_ if not installed yet: `sudo npm -g i yarn`
- Install packages: `yarn --cwd ./frontend`
- Create **frontend run configuration**
- Run > Edit Configurations > + (new configuration) >
- _community edition_ Shell Script
- Script path: _path/to/npm_
- Script options: `start`
- Working directory: _path/to/frontend_
- Interpreter path: _empty_
- _ultimate edition_ npm
- It just works (Andre)
- Choose an active profile
The profile `mcloud` might be active by default when starting the frontend interface. Choose your target profile for
development through the following steps:
- Start backend and frontend and navigate to frontend home page
- Click on the three-dots icon in the top right corner and choose `Allgemein`
- Navigate to `Katalogverwaltung` and add a new catalog with the target profile
- Activate your newly created catalog
You are all set. Run server and frontend with the appropriate run configuration.
### Update dependencies
To get a list of new versions of our dependencies you can run the following command:
For the server:
```shell
./gradlew :server:dependencyUpdates
```
Do not forget to update the lock file for the dependencies. This can be done with the following command:
```shell
./gradlew -PbuildProfile=prod -Plock :server:dependencies --write-locks
```
For the frontend:
```shell
cd frontend && yarn upgrade-interactive
```
## Apache Configuration
For the apache configuration use the following settings:
```
location /ige-server/ {
add_header 'Access-Control-Allow-Origin' *;
add_header 'Access-Control-Allow-Credentials' 'true';
add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT,DELETE, OPTIONS';
add_header 'Access-Control-Allow-Headers' 'Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Mx-ReqToken,X-Requested-With';
proxy_pass http://192.168.0.238:8111/;
}
```
To get the swagger-api json documentation go to http://localhost:8550/v3/api-docs. The UI version can be accessed
with http://localhost:8550/swagger-ui.html, where you also can test the API.
# Tests
For end-to-end tests with Cypress check out the README.md inside `frontend/e2e` directory.
# Release
## Update changelog
TBD
## Release a new version
- Set an annotated tag to the latest commit which represents the release
- use this format `..`, e.g. 1.3.0
- push tag (with commit) to remote, which will trigger a new build in Jenkins
# Jenkins Setup
The following behaviours for the Jenkins project have to be applied:
- Advanced clone behaviours
- to fetch tags so that the correct version is calculated
- Check out to matching local branch
- to get branch information for creating correct tag for docker image
# FAQ
## Error after login: ERR_TOO_MANY_REDIRECTS
A problem occurs when running Keycloak and Application in a docker container on your local machine. Then it's important
that the access to the keycloak instance is the same for the backend as in the frontend in the browser, which happens
actually on the local machine (not inside docker). Therefore, you need to configure `/etc/hosts` file or under windows `
c:\Windows\System32\Drivers\etc\hosts` and add the following entry:
> 127.0.0.1 keycloak
In your docker-compose file you would then use for your app the environment variable "KEYCLOAK_URL=http://keycloak:8080"
to access keycloak in the container. Moreover, make sure the port mapping is the same "8080:8080" otherwise keycloak
won't be able to map correctly.
## Add a new keycloak user
When adding a new keycloak user, make sure to assign the correct roles: ige-user (needed!) and optional ige-super-admin