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