Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbv/jskos-web
Web interface to view JSKOS data
https://github.com/gbv/jskos-web
coli-conc
Last synced: 19 days ago
JSON representation
Web interface to view JSKOS data
- Host: GitHub
- URL: https://github.com/gbv/jskos-web
- Owner: gbv
- License: mit
- Created: 2021-05-07T10:01:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T11:06:27.000Z (4 months ago)
- Last Synced: 2024-11-10T03:17:22.377Z (3 months ago)
- Topics: coli-conc
- Language: Vue
- Homepage: https://coli-conc.gbv.de/data/
- Size: 917 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jskos-web
> Web interface to view JSKOS data
Under construction.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Development](#development)
- [Production](#production)
- [Configuration](#configuration)
- [API](#api)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)
## Install
You will need Node.js 18 or later. Currently, using v20 is recommended.
~~~bash
git clone https://github.com/gbv/jskos-web.git
cd jskos-web
npm install
~~~
## Usage
### Development
```bash
npm run dev
```
This opens a dev server on http://localhost:3453.
### Production
```bash
# 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:
```bash
# 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](https://github.com/stefandesu)
- [@nichtich](https://github.com/nichtich)
## Contribute
PRs accepted.
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
MIT Copyright (c) 2024 Verbundzentrale des GBV (VZG)