TogetherPlatform » TP-CM

<img src="https://elmar-dott.com/wp-content/uploads/ElmarDott.com_.jpg" style="float:left; height:50%; width:50%;" />

# together Platform :: Configuration Management

This repository includes all necessary files to build and compile artifacts of the project together platform (TP).

## Getting Started

The directory build-workflow contains the parent-pom and all global dependencies groupt by libraries. To make the POMs available for your project, run the pom.xml in the root folder from the command line and type mvn. Thats all.

The initializations scripts for the DBMS you will find in the dbms/src/sql directory.

For additional services like database server and so on, are Docker containers the choice. in the folder docker you find a linux script to install docker on Ubuntu. Depending on your OS and Docker version, some adoptions to install docker could be needed. Please use check as first the official documentation to install and run docker on your maschine.

KISS: Keep it simple stupid. Because of this community images from DockerHub are completely sufficient to deal with. To make those images ready for production please check the documenation page of the images. The README files inside of the docker sevice folders gives detailed information how to run the image in the context of together platform.

### Prerequisites

* Java 11 SE adopt openJDK

* Maven 3.8.x

* Docker.io

* NetBeans IDE (recommended) / JetBrains IntelliJ / Eclipse

### Installation

All released Artifacts will be available on Maven Central for usage.

**Maven**

PARENT POM: build workflow

```XML

<parent>

    <groupId>io.github.together</groupId>

    <artifactId>build-workflow</artifactId>

    <version>1.4.0</version>

</parent>

```

For using the bundles in your project you can place the following configuration in your POM. If you already use the the build-workflow as your parent POM then you don't need to insert the <dependency> section.

```XML

<dependencyManagement>

    <dependencies>

        <dependency>

            <groupId>io.github.together.libraries</groupId>

            <artifactId>bundle-spring</artifactId>

            <version>${framework.spring.version}</version>

            <type>pom</type>

        </dependency>

        <dependency>

            <groupId>io.github.together.libraries</groupId>

            <artifactId>bundle-hibernate</artifactId>

            <version>${framework.hibernate.version}</version>

            <type>pom</type>`

        </dependency>`

        <dependency>`

            <groupId>io.github.together.libraries</groupId>

            <artifactId>bundle-jarkarta</artifactId>

            <version>${framework.jarkarta.version}</version>

            <type>pom</type>

        </dependency>

    </dependencies>

</dependencyManagement>

```

```XML

</dependencies>

    <dependency>

        <groupId>io.github.together.libraries</groupId>

        <artifactId>bundle-hibernate</artifactId>

        <type>pom</type>

    </dependency>

    <dependency>

        <groupId>io.github.together.libraries</groupId>

        <artifactId>bundle-spring</artifactId>

        <type>pom</type>

    </dependency>

    <dependency>

        <groupId>io.github.together.libraries</groupId>

        <artifactId>bundle-jarkarta</artifactId>

    </dependency>

</dependencies>

```

## Usage

The build workflow (parent-pom) contains some useful features like distributed 

dependency management and a well defined reporting. For report creation, it is only

neccesary to run the mvn site command. This will generate JavaDoc,

Cobertura test Coverrage, Checkytle, PMD, Findbugs, BDD JGiven documentation and

some other usful informations.

The release policy for all together Platform modules is based on this reports. The

rules for deployed (published) Releases are:

* fix all compiler warnings

* jacoco full project coverage more than 80%

* all test have to pass (no skip)

* no SNAPSHOT artifacts as dependencies

* minimize all possible PMD, Findbugs & Checkstyle warnings. (sometimes they can't fixed)

The library POM is a reactor POM, to simplyfiy the deploy process. Library get only

in the case released, when bundles new added. Changes of existing bundels, like

udate a version of an dependency implies a new release of the bundle and the build-workflow.

## Authors

* **Elmar Dott** - [*Concept, Architecture, Development*](https://elmar-dott.com)

## License

This project is licensed under the Apache 2.0 license.

## Contributors

Feel free open a pull request or to send a feature request by e-mail in the case you want to contribute the project. Everyone is welcome, even beginners in programming. I also appreciate help by optimizing the documentation and creating tutorials.

Mistakes happen. But we only able to fix them, when we you inform us you found a bug. Do not hesitate to send a report in the way you feel common. I try to give as much as possible fast & direct support.

In the case you like this project, let me know it and rate it with a star.