Skip to main content

Module scaffolding

Module scaffolding 

Source
Expand description

Project scaffolding utilities

This module handles the creation of directories and files for new AllFrame projects following Clean Architecture principles.

The scaffolding creates a complete project structure with:

  • Domain layer (business logic, no dependencies)
  • Application layer (use case orchestration)
  • Infrastructure layer (external implementations)
  • Presentation layer (HTTP/API handlers)

§Archetypes

Different archetypes have different directory structures:

§Basic

Simple Clean Architecture project with greeter example.

§Gateway

API Gateway service with gRPC, including:

  • Protocol buffer definitions
  • HTTP client for external APIs
  • Rate limiting and caching
  • Authentication (HMAC, API Key, etc.)

Functions§

create_acl_structure
Create the Anti-Corruption Layer Architecture directory structure
create_bff_structure
Create the BFF (Backend for Frontend) Architecture directory structure
create_consumer_structure
Create the Consumer Architecture directory structure
create_directory_structure
Create the Clean Architecture directory structure
create_gateway_structure
Create the Gateway Architecture directory structure
create_producer_structure
Create the Producer Architecture directory structure
create_saga_structure
Create the Saga Orchestrator Architecture directory structure
create_scheduled_structure
Create the Scheduled Jobs Architecture directory structure
create_websocket_structure
Create the WebSocket Gateway Architecture directory structure
generate_acl_files
Generate all Anti-Corruption Layer project files
generate_bff_files
Generate all BFF project files
generate_consumer_files
Generate all consumer project files
generate_files
Generate all project files with Clean Architecture structure
generate_gateway_files
Generate all gateway project files
generate_producer_files
Generate all producer project files
generate_saga_files
Generate all Saga Orchestrator project files
generate_scheduled_files
Generate all scheduled jobs project files
generate_websocket_files
Generate all WebSocket Gateway project files