FAIR Data Point

FAIR Data Point (FDP) is a REST API for creating, storing, and serving FAIR metadata. This FDP implementation also presents a Web-based graphical user interface (GUI). The metadata contents are generated semi-automatically according to the FAIR Data Point software specification document.

More information about FDP and how to deploy can be found at FDP Deployment Documentation.

Related projects

• FAIR Data Point Client
• FAIR Data Point E2E Tests
• FAIR Data Point Docs
• OpenRefine Metadata Extension

How to contribute

Install requirements

Stack:

• Java (minimal: JDK 15)
• Maven (recommended: 3.2.5 or higher)
• Docker (recommended: 17.09.0-ce or higher) - for build of production image

Build & Run

To run the application, a MongoDB instance is required to be running. To configure the mongodb address, instruct spring-boot to use the development profile. Run these commands from the root of the project.

$ mvn spring-boot:run -Dspring-boot.run.profiles=development

Alternatively, create an application.yml file in the project root and configure the mongodb address, and then run these commands from the root of the project.

$ mvn spring-boot:run

Run tests

Run these commands from the root of the project:

$ mvn test

Package the application

Run these commands from the root of the project:

$ mvn package

Create a Docker image

Run these commands from the root of the project (requires building jar file using mvn package):

$ docker build -t fairdatapoint:local .

Build using Docker

If you do not have Java and Maven locally, you can build the Docker image using Docker (instead of using locally built jar file):

$ docker build -f Dockefile.build -t fairdatapoint:local .

Security

Most of the GET requests are publicly accessible compares to POST, PUT, and PATCH requests, which are mainly secured. We use JWT Tokens and Bearer Token Authentication. The token can be retrieved in /tokens endpoint where you send username and password.

Default users

• ADMIN:
  • Username: [email protected]
  • Password: password
• USER:
  • Username: [email protected]
  • Password: password

API documentation

FAIRDataPoint (FDP) API comes with an embedded swagger documentation, the details of API calls can be found here. To access the FDP swagger document please visit the following url via web browser http://localhost:8080/swagger-ui.html

License

This project is licensed under the MIT License - see the LICENSE file for more details.