README.md

jskos-web

Web interface to view JSKOS data

Under construction.

Table of Contents

• Install
• Usage
  • Development
  • Production
• Configuration
• API
• Maintainers
• Contribute
• License

Install

You will need Node.js 18 or later. Currently, using v20 is recommended.

git clone https://github.com/gbv/jskos-web.git
cd jskos-web
npm install

Usage

Development

npm run dev

This opens a dev server on http://localhost:3453.

Production

# Bundle Vue files
npm run build
# Run server in production
# Alternatively, you can statically host the built files in dist/
npm run serve

Configuration

You can adjust a few configuration options in .env. Here are the available options:

# A list of supported login-server instances
LOGIN_SERVER=http://localhost:3004/,https://coli-conc.gbv.de/login/
# A list of supported jskos-server instances
JSKOS_SERVER=http://localhost:3000/,https://coli-conc.gbv.de/api/
# Base for URL (e.g. when not running under root of domain)
BASE=/

API

TODO

Maintainers

• @stefandesu
• @nichtich

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT Copyright (c) 2024 Verbundzentrale des GBV (VZG)