Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/clarin-eric/linkchecker-api

Spring based web interface for linkchecker

https://github.com/clarin-eric/linkchecker-api

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Spring based web interface for linkchecker

Basic Info
  • Host: GitHub
  • Owner: clarin-eric
  • License: gpl-3.0
  • Language: Java
  • Default Branch: main
  • Size: 203 KB
Statistics
  • Stars: 0
  • Watchers: 8
  • Forks: 0
  • Open Issues: 1
  • Releases: 23
Created almost 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License

README.md

Linkchecker-web

General

Linkchecker-web is a REST API based on SPRING BOOT, which serves as an web interface to the link checker database. The structure of this database is determined by the curation-persistence project, which is included as a maven dependency.

Requirements

  • JDK21 or higher to maven-build the application
  • JRE21 or higher to run the application
  • a mariadb database-server and an empty database with the right for the application user to create the table structure in this database

Setup

Linkchecker-web is a mavenized project. As for all Spring Boot projects created in the standard way by Spring initializr the project has a maven wrapper which assures the use of an appropriate version of maven. This means you don't have to install any maven yourself! After downloading the project, you cd to the project directory and execute

mvnw install

This builds an executable file at /target/linkchecker-web.jar and installs the classes in the maven repository (usually ~/.m2).

Configuration

To run the linkchecker-web application a configuration file has to be provided, which has at least the settings for a spring.datasource (see Data Properties) and spring.security.user (see Security Properties). For more information on different file formats and locations of the configuration file, have a look at the Spring Boot documentation, please.
A sample file in yaml format is in the /config directory of this project. We recommend not to include the configuration file in the jar-build, but to place it either in a /config directory or to specify the file location with the property spring.config.location (see next section).

Running the application

The build jar file is a so called 'fat client', which includes tomcat as an application server. Hence, all you have to do is to run the application with

java -jar linkchecker-web<version>.jar [--spring.config.location=<path to configuration file>]

If you haven't configured any other port (see here), the application will run by default on port 8080.

Owner

  • Name: CLARIN ERIC
  • Login: clarin-eric
  • Kind: organization
  • Email: trac@clarin.eu
  • Location: Utrecht, The Netherlands

CLARIN central source code hub

GitHub Events

Total
  • Release event: 1
  • Push event: 5
  • Create event: 2
Last Year
  • Release event: 1
  • Push event: 5
  • Create event: 2