Skip to content

AAFC DINA Collection module implementation / Implémentation du module de Collection DINA de AAC

License

Notifications You must be signed in to change notification settings

AAFC-BICoE/natural-history-collection-api

Repository files navigation

natural-history-collection-api

AAFC DINA Natural History Collection module implementation.

Features :

  • Implements DINA collection specification
  • Aligns with Darwin Core standard
  • Supports field extensions based on MixS specification
  • Optional Message Queue producer for integration (e.g. search index)

Container Image

The Docker Image is available on DockerHub.

Documentation

See documentation page.

Required

  • Java 21
  • Maven 3.8 (tested)
  • Docker 20+ (for running integration tests)

dina-base-api

natural-history-collection-api relies heavily on dina-base-api.

IDE

natural-history-collection-api requires Project Lombok to be setup in your IDE.

See Lombok Setup documentation

To Run

For testing purpose a Docker Compose example file is available in the local folder. Please note that the app will start without Keycloak and in dev mode.

Create a new docker-compose.yml file and .env file from the example file in the local directory:

cp local/docker-compose.yml.example docker-compose.yml
cp local/*.env .

Start the app (default port is 8085):

docker-compose up

Once the services have started you can access metadata at http://localhost:8085/api/v1/collecting-event

Cleanup:

docker-compose down

About

AAFC DINA Collection module implementation / Implémentation du module de Collection DINA de AAC

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages