mataba/shop/README.md

XShop — Persian-first WooCommerce Theme + Companion Plugin

Commercial, RTL/LTR, responsive, accessible, performant. Sold on RTL-Theme / راست‌چین.

Components

• xshop-theme/ — presentation (templates, design system, RTL, header/footer builders).
• xshop-core/ — functionality (wishlist, compare, Q&A, AJAX search/filter, banners, demo import).

Docs

• docs/PRODUCT-SPEC.md — product spec
• docs/ARCHITECTURE.md — architecture
• docs/FEATURE-MATRIX.md — feature matrix
• docs/ROADMAP.md — roadmap & phases
• docs/UI-SPEC.md — design system
• docs/DATABASE-MODEL.md — data model
• docs/SECURITY.md — security
• docs/PERFORMANCE.md — performance
• docs/TESTING.md — testing
• docs/COMPATIBILITY.md — compatibility
• docs/ADR/ — architecture decision records

Requirements

• WordPress 6.4+, WooCommerce 8.0+, PHP 8.2+, modern browsers.

Quick Start (dev)

1. Copy xshop-theme/ to wp-content/themes/xshop/.
2. Copy xshop-core/ to wp-content/plugins/xshop-core/.
3. Activate theme + plugin. Run setup wizard (XShop → Setup Wizard).

Development Principles

See docs/ARCHITECTURE.md and AGENTS.md (if present). No TODO placeholders in releases. WC is source of truth for commerce; WP for content.

License

Commercial. Third-party assets documented in xshop-theme/docs/ and CHANGELOG.md.