The perfect starting point for XCRUD and XCRUD Pro users!
This simple yet complete demo app shows how easy it is to create fully installable modules with the xApps system.
After installation you get:
• A dedicated role with proper permissions
• Automatic hierarchical menu creation
• A pre-created user account (hello / 123)
• A fully functional XCRUD grid for managing messages (create, read, update, delete)
Ideal for learning how xApps work, testing the install/uninstall process, or as a clean base for building your own professional extensions.
Built with the latest 2026 xApps features: dynamic role/menu/user creation via app.json.
Download to install and access locally.
App Details
| Version | 1.0.0 |
| Released | — |
| Last Updated | — |
XCRUD PRO xAPPS - MANUAL (2026)
===============================
What is an xApps App?
---------------------
An xApps App is a fully modular, installable/uninstallable plugin package for XCRUD Pro.
It works like a standalone mini-application that can be added or removed from your system without leaving any trace.
Each app can:
- Create its own database tables
- Define custom roles and permissions
- Automatically build hierarchical menu structures
- Create dedicated users with predefined credentials
- Add custom PHP pages (CRUD grids, forms, dashboards, etc.)
- Provide custom callback functions
- Install and uninstall cleanly via the built-in App Store
Apps are discovered automatically and managed from the central xApps → App Store interface.
App Folder Location
-------------------
All apps live in:
/lib/apps/<app_folder_name>/
Example: /lib/apps/helloworld/
Current App Folder Structure (2026)
-----------------------------------
A typical app contains:
<app_folder>/
├─ app.json ← Core metadata + dynamic installer config
├─ db/
│ ├─ install.sql ← Legacy SQL (optional – runs after app.json logic)
│ └─ uninstall.sql ← Cleanup SQL (optional)
├─ pages/
│ └─ *.php ← Your XCRUD pages that will be copied to /pages/
├─ lib/
│ └─ xcrud/
│ └─ function_<unique_key>.php ← Optional custom callbacks
├─ app.png (or icon.png) ← Icon shown in App Store
├─ manual.txt ← This manual (shown in App Store)
└─ files.txt ← File listing (shown in App Store)
app.json – The Heart of Modern xApps
------------------------------------
Since 2026, app.json is the primary installer. It allows apps to:
- Define roles with full menu hierarchies (parent → child → grandchild)
- Automatically create users with hashed passwords
- Assign roles to users
- Declare metadata (version, license, requirements, dates, etc.)
Legacy install.sql is still supported and runs after app.json processing.
Key fields in app.json:
- unique_key ← Must be globally unique across all apps
- slug, title, version, description, author, icon
- license, requires_php, requires_xcrud
- release_date, last_updated
- roles[] ← Array of roles with nested pages[] and children[]
- users[] ← Optional predefined users with assign_roles[]
Without a valid app.json, the app will not be detected.
Installation Process (2026)
--------------------------
When you click "Install Now":
1. Pages from /pages/ are copied to the main /pages/ folder with prefix (e.g., hello-world_myfile.php)
2. Optional custom function file is copied to /lib/xcrud/
3. app.json is processed:
- Roles are created/updated
- Full menu tree is built (with icons, sequence, visibility, etc.)
- Users are created with securely hashed passwords
- Roles are assigned to users
4. Legacy install.sql is executed (if present)
5. App status changes to "installed"
Uninstall reverses everything cleanly:
- Deletes copied pages and function file
- Removes menu items, roles, and app-specific users
- Runs uninstall.sql (if present)
Why Use xApps?
--------------
- True modularity: install only what you need
- Clean removal: no orphaned tables, menus, or files
- Perfect for sharing/selling extensions
- Ideal for demos, client projects, and marketplace apps
Welcome to the future of XCRUD Pro extensions!
— xCRUD Pro Team, 2026
Hello World Demo App — Complete File List (2026)
===============================================
This minimal demo showcases the full power of the modern xApps system (2026 version).
Files included in this package:
/lib/apps/helloworld/app.json
→ Core configuration: metadata, roles, menu tree, demo user creation
/lib/apps/helloworld/db/install.sql
→ Legacy SQL script (demonstrates optional backward compatibility)
/lib/apps/helloworld/db/uninstall.sql
→ Cleanup script (optional)
/lib/apps/helloworld/pages/hello_world_messages.php
→ Main XCRUD page: simple messages table with full CRUD
/lib/apps/helloworld/app.png
→ App icon displayed in the App Store
/lib/apps/helloworld/manual.txt
→ Detailed user manual (visible in App Store)
/lib/apps/helloworld/files.txt
→ This file list (visible in App Store)
Note: No custom functions are needed for this simple demo, so the lib/xcrud/ folder is empty.
After installation:
- A new role "Hello World User" is created
- A hierarchical menu appears: Hello World Demo → Messages
- A demo user "hello" (password: 123) is created and assigned the role
- The CRUD page is accessible via the menu