Overview

Below you will find high level documentation on the application code and its structure. In future, there will be more detailed documentation for other pieces of the application.

Public

The public directory contains the public facing files for the application. This includes the index.php file which is the main entry point for the application and the assets directory which contains the static assets for the application.

• index.php - The main entry point for the application. It is the file that is called when the application is accessed. It is responsible for routing the request to the appropriate controller and rendering the appropriate view.
• assets - The assets directory contains the static assets for the application. This includes the CSS, JavaScript, and other assets that are used by the application.

src

The src directory contains the source code for the application. This includes the controllers, models, services, and other code that is used by the application.

• Controllers - The Controllers directory contains the endpoints for the application. Controllers are responsible for handling the request and returning the appropriate response.
• Models - The Models directory contains the models for the application. Models are mappings of the data from the docker api to objects that are used by the application.
• Services - The Services directory contains the services for the application. Services are responsible for providing the core logic and functionality for the application.
• Clients - The Clients directory contains the clients for the application. Clients are responsible for quering the docker api and returning the appropriate data.

vendor

The vendor directory contains the dependencies for the application. This includes the autoloader and other dependencies that are used by the application.

Diagram