docs: update README with MokoSuite naming and current feature status
Rename from MokoJoomStoreLocator to MokoSuiteStoreLocator, update package element names, add implemented vs planned feature sections, add development instructions. Authored-by: Moko Consulting
This commit is contained in:
@@ -1,14 +1,14 @@
|
||||
# MokoJoomStoreLocator
|
||||
# MokoSuiteStoreLocator
|
||||
|
||||
A Joomla 4/5 package providing a store locator listing component with coordinating map and search modules.
|
||||
|
||||
## Package Contents
|
||||
|
||||
| Extension | Description |
|
||||
|---|---|
|
||||
| `com_mokojoomstorelocator` | Component for managing store locations (admin CRUD + frontend listing) |
|
||||
| `mod_mokojoomstorelocator_map` | Site module displaying an interactive map with location markers |
|
||||
| `mod_mokojoomstorelocator_search` | Site module providing search/filter form for finding locations |
|
||||
| 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` |
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -18,17 +18,34 @@ A Joomla 4/5 package providing a store locator listing component with coordinati
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download the latest `pkg_mokojoomstorelocator-x.x.x.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomStoreLocator/releases)
|
||||
1. Download the latest `pkg_mokosuitestorelocator-x.x.x.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteStoreLocator/releases)
|
||||
2. In Joomla Administrator, go to **System > Install > Extensions**
|
||||
3. Upload the package ZIP — all extensions install automatically
|
||||
|
||||
## Features
|
||||
|
||||
- Manage store locations with address, coordinates, contact info, and business hours
|
||||
### Implemented
|
||||
- **Admin CRUD** — full location management with tabbed edit form (details, address, coordinates, contact, image)
|
||||
- **Admin list** — searchable, filterable, sortable locations list with bulk publish/unpublish/delete
|
||||
- **Site frontend** — locations list and detail views with pagination
|
||||
- **Schema.org** — LocalBusiness structured data markup on all frontend templates
|
||||
- **SEF URLs** — router with menu, standard, and nomenu rules
|
||||
- **Menu items** — "All Locations" list and single "Location Detail" picker
|
||||
|
||||
### Planned
|
||||
- Interactive map display (OpenStreetMap/Leaflet or Google Maps)
|
||||
- Location search by city, postcode, or radius
|
||||
- Schema.org LocalBusiness structured data markup
|
||||
- Category support for grouping locations
|
||||
- Location search by city, postcode, or radius with geolocation
|
||||
- Multi-category support with custom map markers
|
||||
- REST API via Joomla Web Services plugin
|
||||
- MokoSuiteShop integration for multi-store ecommerce
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
composer install # Install PHP dev dependencies
|
||||
```
|
||||
|
||||
Source code lives in `source/packages/` — one directory per sub-extension.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user