create-component

Scaffold Apache OFBiz components with standard directories and configuration files.

175|216|Updated Mar 5, 2017

Search Tags:#development #scaffolding #plugin #component #gradle #ofbiz

Ready to run

npx skills add https://github.com/apache/ofbiz-plugins --skill create-component-apache

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: create-component
Source: https://github.com/apache/ofbiz-plugins/tree/main/ai-agent-skills/create-component
Command: npx skills add https://github.com/apache/ofbiz-plugins --skill create-component-apache

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of new, isolated OFBiz components (plugins) with the correct directory structure and initial configuration, streamlining the development process for new features or modules.

Core Features & Use Cases

Component Scaffolding: Generates a new OFBiz component with standard directories (src, webapp, entitydef, etc.).
Configuration Setup: Assists in setting up initial configuration files like ofbiz-component.xml and security data XML.
Use Case: When starting a new e-commerce feature set that requires its own module, use this Skill to quickly set up the plugins/my-custom-ecommerce directory with all necessary subfolders and basic configuration.

Quick Start

Run the Gradle command to create a new plugin named 'my-new-plugin'.

Frequently Asked Questions about create-component

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create a new OFBiz plugin component?▼

Scaffolding a new OFBiz component creates an isolated plugin using the Gradle wrapper, generating standard directories like src and webapp, along with initial configuration files such as ofbiz-component.xml for proper module registration.

What directory structure is generated when scaffolding an OFBiz component?▼

Scaffolding an OFBiz component generates a standard directory structure including src, webapp, and entitydef directories. It also creates initial configuration files like ofbiz-component.xml and security data XML to ensure adherence to OFBiz development conventions.

Do I need Gradle to set up a new Apache OFBiz module?▼

Yes, you need the Gradle wrapper to set up a new Apache OFBiz module. The Skill relies on the Gradle wrapper to automate the creation of the standard directory structure and initial configuration files for isolated custom code.

When should I create a separate OFBiz plugin instead of modifying the core?▼

You should create a separate OFBiz plugin when starting a new feature set or e-commerce module that requires isolated custom code. This approach keeps new features modular and adheres to standard OFBiz development conventions without altering the core.

How do I register a custom e-commerce feature set in OFBiz?▼

To register a custom e-commerce feature set in OFBiz, scaffold a new plugin in the plugins directory to generate ofbiz-component.xml. This configuration file ensures proper component registration within the OFBiz ecosystem.