Companion (Design Document)

Companion comes with a Schema and CLI, such that given a YAML file as input, we can create an entire Causeway application.

Companion CLI

@startuml

:companion-app.yaml;

:root
└── module 1
    └── entities
    └── viewmodels
└── module 2
    └── entities
    └── viewmodels
..
└── webapp
└── test;

@enduml

Companion Schema

Various aspects of the resulting application can be configured.

Entities and Viewmodels

Auto generates entities and viewmodels from provided Companion Schema.

Docker

JIB support.

Documentation

Using Antora.

CI

Support for Github and Gitlab.