Skip to content

Web service for enriching subject indexing data on the basis of mappings.

License

Notifications You must be signed in to change notification settings

gbv/coli-rich-web

Repository files navigation

coli-rich Web Interface

License standard-readme compliant

Web service for enriching subject indexing data on the basis of mappings.

Note: This is currently a preview with no capability to write back into the catalogue.

Table of Contents

Install

Requires Node.js 20+.

git clone https://github.com/gbv/coli-rich-web.git
cd coli-rich-web
npm ci

To run the development server on port 3454:

npm run dev

To run the production server, you need to build the Vue.js frondend first, then start the server:

npm run build
npm run start

Usage

There is an input form to give a PPN from K10plus catalogue.

  • The PPN is looked up via subjects API to get a list of concepts, the record is indexed with (e.g. DDC Numbers, BK Notations...)
  • Each subject is then queried to get mappings from via JSKOS API and corresponding enrichments
  • Enrichments can be selected
  • Writing selected enrichment back to K10plus has not been implemented yet

Configuration

Configuration can be adjusted via a .env file. Variables prefixed with VITE_ can be used in the client as well.

PORT=3454
# Base path on which your app will be hosted
BASE=/
# Login Server instance base URL
VITE_LOGIN_SERVER=http://localhost:3004
# Hardcoded list of allow user URIs that can perform enrichments in the backend
VITE_ALLOWED_USERS=uri1,uri2

To-Dos

  • Code cleanup
    • Split App.vue into multiple components
    • Simplify code where necessary
    • Separate configuration
  • Add more examples?
  • Fix concept data for Wikidata, STW, ...
  • Add favicon
  • ...

Maintainers

Contribute

PRs accepted.

License

MIT © 2024 Verbundzentrale des GBV (VZG)