pid-ms-api

Persistant IDentifier MicroService API can create URN, Handle or DOI

https://github.com/cscfi/pid-ms-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 (8.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Persistant IDentifier MicroService API can create URN, Handle or DOI

Basic Info
  • Host: GitHub
  • Owner: CSCfi
  • License: apache-2.0
  • Language: Java
  • Default Branch: main
  • Size: 392 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed 12 months ago
Metadata Files
Readme License Codemeta

README.md

PID microservice API project

Documentation

The program has usage directory to add documentation, but currently it's still internal: https://wiki.eduuni.fi/display/CSCdatamanagementoffice/PID-service+REST+API+description and https://wiki.eduuni.fi/display/CSCdatamanagementoffice/PID+Service+architechture This project uses Quarkus 3.1.

It require database, which is plannet to run as service to many organizations: not so trivial as it can be.

Running the application in dev mode

You can run your application in dev mode that enables live coding using: mvn quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using mvn package. It produces the quarkus-run.jar file in the /target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib directory.

If you want to build an über-jar, execute the following command: shell script .mvn package -Dquarkus.package.type=uber-jar

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

Creating a native executable

I tried to create a native executable using: mvn -Dquarkus.container-image.builder=jib package -Pnative -Dquarkus.native.container-build=true -Dquarkus.native.container-runtime=podman -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-mandrel:20.2-java11, but got Image generation failed. Exit code: 125

Ja ylläoleva virhe korjautuu käyttämällä tunnusta, jonka uid on 1000 tai enemmän centos 8:ssa. Eli konento toimii.

You can create a native executable using: shell script mvn package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using: shell script mvn package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/api-1.0.2-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/building-native-image.

Authors

  • Pekka Järveläinen

Owner

  • Name: CSC - IT Center for Science
  • Login: CSCfi
  • Kind: organization
  • Email: vcs-support@csc.fi

Finnish expertise in ICT for research, education, culture and public administration

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "codeRepository": "https://github.com/CSCfi/PID-MS-API.git",
  "dateCreated": "2022-05-24",
  "datePublished": "2023-05-24",
  "dateModified": "2023-05-24",
  "name": "PID-MS-API",
  "version": "1.1.",
  "identifier": "swh:1:dir:a85b94f62904059ac4a6cb057df0ab0dfb38ca6a;",
  "description": "Persistant IDentifier MicroService API can create URN, Handle or DOI. It's Quarkus program targeted to run as service.",
  "applicationCategory": "PID",
  "developmentStatus": "active",
  "funder": {
    "@type": "Organization",
    "name": "Ministry of Education and Culture, Finland"
  },
  "keywords": [
    "URN",
    "Handle",
    "DOI",
    "PID"
  ],
  "programmingLanguage": [
    "Java"
  ],
  "runtimePlatform": [
    "JVM",
    "graalVM"
  ],
  "operatingSystem": [
    "Any"
  ],
  "author": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0003-3111-1515",
      "givenName": "Pekka",
      "familyName": "Järveläinen",
      "affiliation": {
        "@type": "Organization",
        "name": "CSC"
      }
    }
  ]
}

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels