DLCM Backend
DLCM-Backend is the backend part of the DLCM technology, an archiving solution based on the OAIS model (ISO 14721).
Prerequisites
The DLCM technology was developed with the Solidify framework, developed by the UNIGE, extended from Spring Boot.
In order to build the DLCM-Backend project, you need to build the following dependencies first with their corresponding versions:
-
solidify : https://gitlab.unige.ch/solidify/solidify-backend
-
solidify-authorization : https://gitlab.unige.ch/solidify/solidify-authorization
-
solidify-tools : https://gitlab.unige.ch/solidify/solidify-tools
-
dlcm-portal : https://gitlab.unige.ch/dlcm/ui/dlcm-portal
If you are inside the UNIGE network, you do not need to build these two projects. If you are outside the UNIGE network, then you will have to pull and build the two dependencies.
Building project
To build the project, run this Maven command
-
If you are inside the UNIGE network:
mvn clean package -
If you are outside the UNIGE Network:
mvn clean package -P public
For Windows users
Add the dlcm.storage.url property in the DLCM-Backend-Solution.yml file by setting a valid path. Example for Windows: file:/C:/Users/<user name>/storage
Generating documentation and the open api specification file
After building the projects, you should see the generated documentation in the DLCM-Solution/target directory and the open api documentation in DLCM-Solution/target/classes/static.
If you want to customize information in the generated doc (url, baseapi, servlet name…), you can edit properties in pom.xml parent:
<documentation.host>localhost</documentation.host>
<documentation.basePath>/</documentation.basePath>
<documentation.specification>OPENAPI_V3</documentation.specification>
<documentation.scheme>http</documentation.scheme>
<documentation.server.servlet.context-path>/dlcm</documentation.server.servlet.context-path>
<documentation.format>JSON</documentation.format>Contributing to project
Please read our contributing guidelines before contributing to the project.