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 (10.1%) to scientific vocabulary
Keywords
Repository
fc4eosc-PIDMR-api
Basic Info
- Host: GitHub
- Owner: FC4E-WP5
- License: apache-2.0
- Language: Java
- Default Branch: master
- Homepage: https://api.pidmr.devel.argo.grnet.gr/
- Size: 677 KB
Statistics
- Stars: 1
- Watchers: 3
- Forks: 5
- Open Issues: 4
- Releases: 6
Topics
Metadata Files
README.md
PID Meta Resolver
The PID Meta Resolver is a generalized resolver for mapping items into records. Actually the PID Meta Resolver will know where to route different types of identifier – ex. DOI, URN:NBN. PID Meta Resolver which should improve a machine based data processing and allows to get digital object information without in-depth knowledge of the resolution mechanism of different PID systems. That enhances the collection and analysis of data collections originating not only from different sources also referenced by different PID systems. The PID Meta Resolver should return a minimal set of information. This creates the connection with the PID Kernel Information.
Expose OpenAPI Specifications
OpenAPI Specifications are accessible at /open-api endpoint.
Swagger UI
Swagger UI is accessible at /swagger-ui endpoint.
Running the application in dev mode
You can run your application in dev mode that enables live coding using:
shell script
./mvnw compile quarkus:dev
NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
Access the Dev Service Database
To access the dev database, please execute the following command:
psql -h localhost -U pidmr -d pidmr
Obtain an access token from Dev Service Keycloak
To obtain an access token from Dev Service Keycloak, please follow the instructions above.
Instructions
- Navigate to the http://localhost:8080
Open your preferred web browser and navigate to the http://localhost:8080 where the access token can be obtained.
- Locate the Access Token Button
Once the web page loads, locate the button that triggers the access token retrieval process. The button should be visible on the web page.
- Click the Obtain an Access Token button
Click the access token button to initiate the process of retrieving an access token. This will trigger the necessary steps to obtain the token from the Dev Service Keycloak.
- Log into Dev Service Keycloak
Use the following credentials to log into Dev Service Keycloak:
1) admin user
- username : `admin`
- password : `admin`
2) provider_admin user
- username : `alice`
- password : `alice`
3) plain user
- username : `evald`
- password : `evald`
- Retrieve the Access Token
After providing the necessary information, the web page will communicate with the authentication server to retrieve the access token. This process may take a few moments. Once the retrieval is successful, the access token will be displayed on the web page.
- Use the Access Token
Once you have obtained the access token, you can use it for authenticating API requests. Follow the documentation or guidelines provided by the API to understand how to include the access token in the appropriate HTTP requests using the Bearer Authentication scheme.
Packaging and running the application
The application can be packaged using:
shell script
./mvnw 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.
The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.
If you want to build an über-jar, execute the following command:
shell script
./mvnw package -Dquarkus.package.type=uber-jar
The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.
Creating a native executable
You can create a native executable using:
shell script
./mvnw package -Pnative
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
shell script
./mvnw package -Pnative -Dquarkus.native.container-build=true
You can then execute your native executable with: ./target/pid-meta-resolver-1.0.0-SNAPSHOT-runner
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
Owner
- Name: FC4E-WP5
- Login: FC4E-WP5
- Kind: organization
- Repositories: 1
- Profile: https://github.com/FC4E-WP5
CodeMeta (codemeta.json)
{
"@context": "https://w3id.org/codemeta/3.0",
"type": "SoftwareSourceCode",
"applicationCategory": "PIDMR - API",
"author": [
{
"id": "https://orcid.org/0009-0004-9021-8034",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "National Infrastructures for Research and Technology - GRNET S.A"
},
"email": "cthermolia@admin.grnet.gr",
"familyName": "Thermolia",
"givenName": "Chryssa"
},
{
"type": "Role",
"schema:author": "https://orcid.org/0009-0004-9021-8034",
"roleName": "Developer"
},
{
"id": "https://orcid.org/0009-0000-0192-3868",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "National Infrastructures for Research and Technology - GRNET S.A"
},
"email": "irina@admin.grnet.gr",
"familyName": "Skopouli",
"givenName": "Irina"
},
{
"type": "Role",
"schema:author": "https://orcid.org/0009-0000-0192-3868",
"roleName": "Developer"
},
{
"id": "https://orcid.org/0009-0003-6339-3278",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "National Infrastructures for Research and Technology - GRNET S.A"
},
"email": "fbasios@admin.grnet.gr",
"familyName": "Basios",
"givenName": "Fotios"
},
{
"type": "Role",
"schema:author": "https://orcid.org/0009-0003-6339-3278",
"roleName": "Developer"
}
],
"codeRepository": "https://github.com/FC4E-WP5/fc4eosc-PIDMR-api",
"dateCreated": "2023-03-17",
"datePublished": "2024-01-31",
"description": "The PID Meta Resolver is a generalized resolver for mapping items into records. Actually the PID Meta Resolver will know where to route different types of identifier ex. DOI, URN:NBN.",
"downloadUrl": "https://github.com/FC4E-WP5/fc4eosc-PIDMR-api/archive/refs/heads/main.zip",
"funder": {
"type": "Organization",
"name": "European Commission"
},
"identifier": "https://github.com/FC4E-WP5/fc4eosc-PIDMR-api",
"isPartOf": "https://faircore4eosc.eu",
"keywords": [
"Quarkus",
"Java",
"API",
"REST"
],
"license": "https://spdx.org/licenses/Apache-2.0",
"name": "PID Meta Resolver",
"operatingSystem": "Rocky Linux 9.0",
"programmingLanguage": "Java",
"runtimePlatform": "JVM",
"version": "v2.3.0",
"developmentStatus": "active",
"funding": "Funded by European Commission under grant number 101057264.",
"issueTracker": "https://github.com/FC4E-WP5/fc4eosc-PIDMR-api/issues"
}
GitHub Events
Total
- Create event: 6
- Release event: 2
- Issues event: 37
- Delete event: 3
- Issue comment event: 19
- Push event: 15
- Pull request review event: 11
- Pull request event: 30
- Fork event: 1
Last Year
- Create event: 6
- Release event: 2
- Issues event: 37
- Delete event: 3
- Issue comment event: 19
- Push event: 15
- Pull request review event: 11
- Pull request event: 30
- Fork event: 1
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 20
- Total pull requests: 13
- Average time to close issues: 5 months
- Average time to close pull requests: 17 days
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 0.7
- Average comments per pull request: 0.0
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 19
- Pull requests: 13
- Average time to close issues: 4 months
- Average time to close pull requests: 17 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 0.63
- Average comments per pull request: 0.0
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- asajedi (25)
- bingert (2)
- fbasios (2)
Pull Request Authors
- fbasios (45)
- cthermolia-grnet (16)
- irinaskop (14)
- themiszamani (4)
- asajedi (1)