README.adoc

AoU Backends

AoU is the acronym of Archive ouverte UNIGE.

AoU-Backend is the backend part of the Archive ouverte UNIGE digital service, an archiving solution for the UNIGE publications.

Prerequisites

The AoU was developed with the Solidify framework, developed by the UNIGE, extended from Spring Boot.

In order to build the AoU-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

• aou-portal : https://gitlab.unige.ch/aou/aou-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

Generating documentation and the open api specification file

After building the projects, you should see the generated documentation in the AoU-Solution/target directory and the open api documentation in AoU-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>

Skipping copyright check

To run a build without the copyright verification, run this Maven command

mvn <goals> -Dlicense.skipCheckLicense

Adding copyright

If missing copyright in new source files, to add the copyright in these file headers, run this Maven command

mvn license:update-file-header

Contributing to project

Please read our contributing guidelines before contributing to the project.