CPS-419: Document Structure CPS Projects

checkstyle

Imports coding standards and practices for developers to adhere to and automates the process of checking if java code is adhering to these rules.

no

cps-application

Spring Application class

yes

cps-bom

Contains dependencyManagement declarations of all published CPS components

no

cps-dependencies

Contains dependencyManagement declarations of upstream versions

no

cps-ncmp-rest

Rest API for NCMP

yes 

cps-ncmp-service

Defines methods for use in NCMP rest API

yes

cps-parent

Contains the parent pom from which all other pom files will inherit.

No

cps-rest

Contains API documentation and rest controllers used in CPS rest API

yes

cps-ri

Responsible for data persistence and retrieval from the database

yes

cps-service

Defines methods for use in CPS rest API and SPI

yes

csit

Contains tests called "test plans" that run one or more test suites written using the Robot Framework. 

no

docker-compose

Starts both Postgres and CPS, docker-compose.yml deploys cps-and-ncmp by default but can be edited to deploy cps-standalone or ncmp-standalone.

no

docs

Documentation for CPS

no

releases

Release info

no

spotbugs

Contains a filter of bug patterns to excluded from spotbugs

no

docs

OpenAPI Documentation

No

src

Contains application class, rest controller and code responsible for data persistence and retrieval from database.

Yes

cps-tdbmt-application

Spring application class

No

cps-tdbmt-bom

Contains dependencyManagement declarations of all published TDBMT components

No

cps-tdbmt-dependencies

Contains dependencyManagement declarations of upstream versions

No

cps-tdbmt-parent

Contains the parent pom from which all other pom files will inherit.

No

cps-tdbmt-rest

Rest controllers and openAPI documentation

Yes

cps-tdbmt-service

Defines methods for use in rest API and is responsible for storing and accessing templates stored in a database

Yes

docker-compose

Starts both Postgres and TBDMT containers

No