Replace all ToDo notes with the appropriate names, descriptions and commands.

ToDo: Project Name

ToDo: Description of the project.

Table of contents

• ToDo: Project Name
  • Table of contents
  • Getting started
    • Prerequisites
    • Source code
    • Execute without Docker
    • Execute with Docker
  • Information
    • Guidelines
    • Support
    • Contributing
    • Documentation
    • Boilerplate
    • License

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To build the project, the following prerequisites must be met:

• ToDo: Check the prerequisites
• Java JDK 1.8 or higher (e.g. OpenJDK)
• Maven 3.x
• PostgreSQL 11

If you want to run the application using Docker, the environment is already set up with all dependencies for you. You only have to install Docker and Docker Compose and follow the instruction in the dedicated section.

Source code

Get a copy of the repository:

ToDo: git clone https://github.com/noi-techpark/project-name.git

Change directory:

ToDo: cd project-name/

Execute without Docker

Copy the file src/main/resources/application.properties to src/main/resources/application-local.properties and adjust the variables that get their values from environment variables. You can take a look at the .env.example for some help.

Build the project:

mvn -Dspring.profiles.active=local clean install

Run external dependencies, such as the database:

docker-compose -f docker-compose.dependencies.yml up --detach

Run the project:

mvn -Dspring.profiles.active=local spring-boot:run

The service will be available at localhost and your specified server port.

To execute the test you can run the following command:

mvn clean test

Execute with Docker

Copy the file .env.example to .env and adjust the configuration parameters.

Then you can start the application using the following command:

docker-compose up

The service will be available at localhost and your specified server port.

To execute the test you can run the following command:

docker-compose run --rm app mvn clean test

Information

Guidelines

Find here guidelines for developers.

Support

ToDo: For support, please contact [email protected].

Contributing

If you'd like to contribute, please follow our Getting Started instructions.

Documentation

More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.

Boilerplate

The project uses this boilerplate: https://github.com/noi-techpark/java-boilerplate.

License

The code in this project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 license. See the LICENSE.md file for more information.

REUSE

This project is REUSE compliant, more information about the usage of REUSE in NOI Techpark repositories can be found here.

Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The pre-commit-config file in the repository root is already configured to check for REUSE compliance with help of the pre-commit tool.

Install the tool by running:

pip install pre-commit

Then install the pre-commit hook via the config file by running:

pre-commit install