MokoSuiteChurch/README.md

<!--
 Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
 SPDX-License-Identifier: GPL-3.0-or-later
-->

# MokoSuite Church

Member directory, contributions, ministries, attendance, and facility booking for MokoSuite on Joomla 6.

## Overview

MokoSuiteChurch is a **Layer 2** extension in the MokoSuite platform, building on MokoSuiteClient (Layer 0) and MokoSuiteCRM (Layer 1) to provide complete church management. Members are CRM contacts -- no duplicate user tables.

## Package Contents

| Extension | Type | Description |
|---|---|---|
| `plg_system_mokosuitechurch` | System Plugin | Core helpers, SQL schema, service classes |
| `com_mokosuitechurch` | Component | Admin dashboard, list views, configuration |
| `plg_webservices_mokosuitechurch` | Webservices Plugin | REST API endpoints |

## Features

- **Member Directory** -- CRM contact-linked profiles with membership status lifecycle, family grouping, photo support
- **Family Management** -- household grouping with shared address and contact details
- **Contributions** -- tithe, offering, special, pledge, and in-kind tracking with multiple payment methods
- **Fund Accounting** -- general, building, missions, benevolence, and designated funds with goal tracking
- **Ministry Management** -- ministry teams with leader assignments, member roles, and meeting schedules
- **Attendance Tracking** -- service-level check-in for members and guests across event types
- **Facility Booking** -- room and space management with capacity, booking requirements, and hourly rates
- **REST API** -- full CRUD for members, families, contributions, funds, ministries, attendance, facilities
- **Access Control** -- granular permissions for role-based administration

## Database Schema

8 tables covering the full church management domain:

| Table | Purpose |
|---|---|
| `#__mokosuitechurch_members` | Member profiles linked to CRM contacts with family assignment |
| `#__mokosuitechurch_families` | Family/household grouping with shared contact info |
| `#__mokosuitechurch_funds` | Designated funds with type, goal, and tax-deductible flag |
| `#__mokosuitechurch_contributions` | Individual contributions with fund allocation and receipt tracking |
| `#__mokosuitechurch_ministries` | Ministry teams with type, leader, and schedule |
| `#__mokosuitechurch_ministry_members` | Ministry-member junction with roles |
| `#__mokosuitechurch_attendance` | Event attendance records for members and guests |
| `#__mokosuitechurch_facilities` | Church facilities with type, capacity, and booking rates |

## Requirements

- Joomla 6.x
- PHP 8.3+
- MokoSuiteClient (Layer 0)
- MokoSuiteCRM (Layer 1)

## Installation

Install via Joomla Extension Manager using the package file `pkg_mokosuitechurch.zip`. The package installs all three extensions (system plugin, component, webservices plugin) in the correct order.

Updates are delivered automatically via the [MokoGitea update server](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteChurch/updates.xml).

## Configuration

Settings are managed via the system plugin parameters:

| Fieldset | Key Settings |
|---|---|
| **Basic** | Church name, denomination, timezone |
| **Contributions** | Fiscal year start month, default fund, receipt format |
| **Membership** | Member ID prefix, auto-assign family |
| **Attendance** | Track attendance toggle, service types |

## License

GNU General Public License v3.0 or later.

## Links

- [Documentation](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteChurch/wiki)
- [Issues](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteChurch/issues)
- [MokoSuite Platform](https://mokoconsulting.tech)