You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The [FAIR Data Point (FDP)]is an HTTP API for creating, storing, and serving FAIR metadata (**F**indable, **A**ccessible, **I**nteroperable, **R**eusable).
10
+
The [FAIR Data Point (FDP)]provides an HTTP API for creating, storing, and serving FAIR (**F**indable, **A**ccessible, **I**nteroperable, **R**eusable) metadata in the form of [RDF].
11
11
The metadata content is generated semi-automatically according to the [FAIR Data Point specification].
12
12
13
13
## Usage
14
14
15
-
More information about FDP, how to deploy it and use it can be found in the [FDP documentation].
15
+
More information about the FDP, how to deploy it, and how to use it, can be found in the [FDP documentation].
16
16
17
17
### API Documentation
18
18
19
-
The FAIR Data Point API comes with embedded [OpenAPI] documentation based on SwaggerUI.
20
-
Each FDP serves human friendly API documentation at the path `/swagger-ui.html`, for example, https://app.fairdatapoint.org/swagger-ui.html.
21
-
In addition, machine readable API docs are available at the path `/v3/api-docs`, for example, https://app.fairdatapoint.org/v3/api-docs.
19
+
The FAIR Data Point API also comes with embedded [OpenAPI] documentation based on SwaggerUI.
20
+
Each FDP serves its own human friendly API documentation at the path `/swagger-ui.html`, for example, https://app.fairdatapoint.org/swagger-ui.html.
21
+
In addition, machine readable API docs (JSON) are available at the path `/v3/api-docs`, for example, https://app.fairdatapoint.org/v3/api-docs.
22
22
23
23
## Development
24
24
25
25
### Technology Stack
26
26
27
+
The FDP runs on the following technology stack and is typically deployed as a Docker container.
28
+
27
29
-**Spring-boot**
28
30
-**Java**
29
31
-**Maven**
30
32
-**MongoDB**
31
-
-**Docker** (only required for building a Docker image)
33
+
-**Docker** (only required for building a Docker image and running the container)
32
34
33
35
### Build & Run
34
36
@@ -49,7 +51,7 @@ $ mvn spring-boot:run
49
51
50
52
### Run tests
51
53
52
-
Run from the root of the project:
54
+
Tests can be run, from the root of the project, as follows:
53
55
54
56
```bash
55
57
$ mvn test
@@ -86,7 +88,7 @@ By default, the FDP sets up the following *default users*.
86
88
## Contributing
87
89
88
90
Interested in contributing to FDP development?
89
-
Take a look at our [contribution guidelines](CONTRIBUTING.md) and [code of Conduct](CODE_OF_CONDUCT.md).
91
+
Take a look at our [contribution guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).
90
92
91
93
## Citation
92
94
@@ -128,3 +130,4 @@ This project is licensed under the MIT License - see the [LICENSE] file for more
0 commit comments