MokoJoomHero

A Joomla Module developed following MokoStandards.

Overview

This is a standardized Joomla module that conforms to Moko Consulting's development standards and best practices. It provides a consistent starting point with pre-configured tooling, documentation structure, and development workflows.

Features

Standardized Structure: Pre-organized directories for source code, documentation, and scripts
Build Automation: Makefile with common tasks (lint, build, package, install)
Code Quality: Pre-configured PHP linting and CodeSniffer for Joomla standards
Development Tools: EditorConfig for consistent coding styles across IDEs
Documentation: Template structure following MokoStandards documentation practices
Git Configuration: Pre-configured git attributes, ignore patterns, and commit message templates

Prerequisites

PHP: 7.4 or higher (8.0+ recommended for Joomla 4.x/5.x)
Joomla: A working Joomla installation for testing (3.x, 4.x, or 5.x)
Make: GNU Make for running build commands

Installation

Build the module package:
```
make build
```
Upload the generated ZIP file via Joomla's Extension Manager

Usage

# Display available commands
make help

# Validate code
make validate

# Build module package
make build

Project Structure

.
├── docs/                # Documentation files
├── scripts/             # Build and deployment scripts
├── src/                 # Module source code
├── Makefile             # Build automation
└── README.md            # This file

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Versioning

This project uses Semantic Versioning.

See CHANGELOG.md for version history.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SPDX-License-Identifier: GPL-3.0-or-later

Support

Documentation: See the docs/ directory
Contact: hello@mokoconsulting.tech
Website: mokoconsulting.tech

2.8 KiB Raw Blame History