--- name: awe-framework description: | Guides AI agents through AWE (Almis Web Engine) framework development: XML descriptor authoring (screens, queries, maintain, services, actions), Java service patterns, project structure, and build workflows. Trigger: When working with AWE, Almis Web Engine, XML descriptors, awe-framework, screen XML, query XML, maintain XML, or ServiceConfig. version: "1.0.0" author: AWE Team license: Apache-2.0 --- # AWE Framework — Agent Skill AWE (Almis Web Engine) is a Java/Spring Boot web application framework where UI, data access, and business logic are defined through XML descriptors rather than handwritten code. This skill teaches you the descriptor system, project layout, Java service patterns, and development workflow. ## When to Use This Skill | Trigger | Example | |---------|---------| | Creating or modifying a screen | "Add a new user management screen" | | Writing or editing a query | "Create a query that joins users and profiles" | | Defining maintain operations | "Add insert/update/delete for the orders table" | | Wiring a Java service | "Expose a service method through XML" | | Defining server actions | "Create an action that calls a maintain target" | | Understanding project structure | "Where do I put screen XML files?" | | Build or test commands | "How do I build and run the application?" | | Adding UI dependencies | "Show/hide a field based on a dropdown value" | | CRUD workflow (end-to-end) | "Create a full CRUD screen for customers" | ## AWE Project Structure ### AWE project archetype AWE projects follow a standard multi-module Maven structure. - AWE with ReactJS frontend: `awe-boot-react-archetype` ```bash mvn -B archetype:generate \ -DarchetypeGroupId=com.almis.awe \ -DarchetypeArtifactId=awe-boot-react-archetype \ -DarchetypeVersion=[Archetype version] \ -DgroupId=com.mycompany.app \ -DartifactId=my-app \ -Dversion=1.0-SNAPSHOT ``` - AWE with AngularJS frontend: `awe-boot-angular-archetype` ```bash mvn -B archetype:generate \ -DarchetypeGroupId=com.almis.awe \ -DarchetypeArtifactId=awe-boot-angular-archetype \ -DarchetypeVersion=[Archetype version] \ -DgroupId=com.mycompany.app \ -DartifactId=my-app \ -Dversion=1.0-SNAPSHOT ``` ### Top-Level Modules ``` awe/ pom.xml # Parent POM awe-framework/ # Core framework (10 sub-modules) awe-dependencies/ # BOM — centralizes dependency versions awe-model/ # Domain model, DTOs (ServiceData, DataList) awe-generic-screens/ # Built-in screens and global XML descriptors awe-client-angular/ # AngularJS 1.5.8 frontend awe-controller/ # Spring MVC controllers and services awe-testing/ # Test utilities and base test classes awe-modules/ # Optional feature modules awe-scheduler/ # Task scheduling module awe-notifier/ # Email/notification module awe-developer/ # Developer tools module awe-builder/ # Application builder module awe-starters/ # Spring Boot auto-configuration starters awe-boot-angular-archetype/ # Maven archetype for Angular apps awe-boot-react-archetype/ # Maven archetype for React apps awe-samples/ # Example applications awe-tests/ # Integration and E2E tests ``` ### XML Descriptor Folder Convention Every AWE module places its descriptors under: ``` src/main/resources/application/{acronym}/ ``` where `{acronym}` is the module identifier (e.g. `awe`, `awe-scheduler`). Inside that folder: | Folder | Purpose | Key Files | |--------|---------|-----------| | `global/` | App-wide definitions | `Queries.xml`, `Maintain.xml`, `Services.xml`, `Actions.xml`, `Email.xml`, `Enumerated.xml`, `Queues.xml` | | `screen/` | Screen definitions | One `.xml` file per screen (e.g. `scheduler-tasks.xml`) | | `locale/` | Internationalization | `Locale-{lang}.xml` files with `` entries | | `menu/` | Navigation menus | `public.xml`, `private.xml` with `

awe-framework

Installation

SKILL.md