MokoSuiteStoreLocator/CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

Project Overview

MokoSuiteStoreLocator -- A Joomla 6 package providing a store locator listing component with coordinating map and search modules.

Field	Value
Platform	joomla
Extension type	package (component + modules)
Element	pkg_mokosuitestorelocator
Language	PHP
Default branch	main
License	GPL-3.0-or-later
Wiki	MokoSuiteStoreLocator Wiki
Standards	MokoStandards

Package Contents

Extension	Type	Element
Store Locator Component	component	com_mokosuitestorelocator
Store Locator Map	module (site)	mod_mokosuitestorelocator_map
Store Locator Search	module (site)	mod_mokosuitestorelocator_search

Common Commands

composer install  # Install PHP dev dependencies

Architecture

This is a Joomla package. Key layout:

• source/pkg_mokosuitestorelocator.xml -- package manifest
• source/script.php -- package install/upgrade/uninstall script
• source/packages/com_mokosuitestorelocator/ -- main component
  • admin/ -- admin MVC (controllers, models, views, forms, tables, SQL)
  • site/ -- frontend MVC (controllers, models, views, templates)
  • mokosuitestorelocator.xml -- component manifest
• source/packages/mod_mokosuitestorelocator_map/ -- map display module
• source/packages/mod_mokosuitestorelocator_search/ -- search/filter module

Database Table

#__mokosuitestorelocator_locations -- stores location data including coordinates, address, contact info, and business hours.

Rules

• Workflow directory: .mokogitea/ (not .gitea/ or .github/)

• Never commit .claude/, .mcp.json, TODO.md, or *.min.css/*.min.js

• Attribution: use Authored-by: Moko Consulting in commits

• Branch strategy: develop on dev/, merge to main for release

• Wiki: documentation lives in the Gitea wiki, not in docs/ files

• Standards: this repo follows MokoStandards

• PHP minimum: 8.2

• Joomla minimum: 5.0

• Joomla table operations: always use bind() -> check() -> store(), never save()

• Namespace: Moko\Component\MokoSuiteStoreLocator for the component