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

Open Data Hub - Web Components Pagebuilder

ToDo: Description of the project.

Table of contents

• Gettings started
• Running tests
• Deployment
• Docker environment
• Information

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

For a ready to use Docker environment with all prerequisites already installed and prepared, you can check out the Docker environment section.

Source code

Get a copy of the repository:

git clone https://github.com/noi-techpark/odh-web-components-pagebuilder.git

Change directory:

cd odh-web-components-pagebuilder/

Build

Build the project:

mvn clean install

Running tests

The unit tests can be executed with the following command:

mvn clean test

Deployment

ToDo: A detailed description about how the application must be deployed.

Docker environment

For the project a Docker environment is already prepared and ready to use with all necessary prerequisites.

These Docker containers are the same as used by the continuous integration servers.

Installation

Install Docker (with Docker Compose) locally on your machine.

Start and stop the containers

Before start working you have to start the Docker containers:

docker-compose up --build --detach

After finished working you can stop the Docker containers:

docker-compose stop

Running commands inside the container

When the containers are running, you can execute any command inside the environment. Just replace the dots ... in the following example with the command you wish to execute:

docker-compose exec java /bin/bash -c "..."

Some examples are:

docker-compose exec java /bin/bash -c "mvn clean install"

# or

docker-compose exec java /bin/bash -c "mvn clean test"

Information

Support

For support, please contact info@opendatahub.com.

Contributing

If you'd like to contribute, please follow the following instructions:

• Fork the repository.

• Checkout a topic branch from the development branch.

• Make sure the tests are passing.

• Create a pull request against the development branch.

Documentation

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

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.