diff --git a/README.md b/README.md index 9a425d0..7c43d0d 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,23 @@ -# Template-Joomla +# MokoSuite Insight -Unified scaffolding templates for all Joomla extension types. +Real-time dashboards, data visualization, KPI monitoring, and alerting for Joomla 6. Connects to all MokoSuite modules. -## Structure +**Standalone** — auto-detects installed MokoSuite modules for data sources. Chart.js 4 rendering. -``` -.gitea/workflows/ ← Standard 10-workflow CI/CD suite -types/ - plugin/ ← Joomla plugin scaffold - template/ ← Joomla site template scaffold (full src/) - module/ ← Joomla module scaffold - component/ ← Joomla component scaffold - package/ ← Joomla package scaffold - library/ ← Joomla library scaffold -``` +## Features -## Usage +- **Dashboards** — drag-and-drop builder, multiple per user, auto-refresh +- **Data Sources** — pluggable connectors (CRM, ERP, POS, Shop, HRM, MRP, Restaurant, NPO, Child, Field) +- **Widgets** — counter, line, bar, pie, gauge, table, sparkline, heatmap, funnel +- **Alerting** — threshold monitoring, cooldown, escalation +- **Export** — CSV from any widget, dashboard snapshots -1. Create a new repo from this template (or clone manually) -2. Copy the relevant `types//` content to your project root -3. Customize the manifest XML, namespace, and source files -4. Workflows are already configured — push to trigger CI +## Helpers (5) -## Shared Files +`DashboardHelper` · `DataSourceHelper` · `AlertHelper` · `WidgetHelper` · `ExportHelper` -The root contains files shared by all extension types: -- `.gitea/workflows/` — CI/CD (auto-release, ci-joomla, pr-check, etc.) -- `.editorconfig`, `.gitignore`, `.gitattributes` — editor/git config -- `composer.json`, `phpstan.neon`, `Makefile` — build tooling -- `updates.xml` — Joomla update server manifest template -- `LICENSE`, `SECURITY.md`, `CONTRIBUTING.md` — standard docs +## Links -## Workflow Suite (10 workflows) +- [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteInsight/wiki) · [Issues](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteInsight/issues) · [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteInsight/releases) -| Workflow | Purpose | -|----------|---------| -| `auto-release.yml` | Stable release on PR merge to main | -| `pre-release.yml` | Manual dev/alpha/beta/rc builds | -| `ci-joomla.yml` | PHP lint, PHPStan, coding standards | -| `pr-check.yml` | PR gate: manifest + build validation | -| `deploy-manual.yml` | Manual SFTP deploy | -| `repo-health.yml` | Structure compliance checks | -| `update-server.yml` | updates.xml validation | -| `security-audit.yml` | Dependency vulnerability scanning | -| `notify.yml` | ntfy notifications | -| `cleanup.yml` | Merged branch + old run cleanup | - -## Version Policy - -- **Stable** (PR merge to main): Minor bump (`03.00.07` -> `03.01.00`) -- **Pre-release** (manual): Patch bump (`03.00.07` -> `03.00.08`) - -## Release Cascade - -Higher releases auto-delete lower pre-release channels: -- stable -> all | rc -> beta,alpha,dev | beta -> alpha,dev | alpha -> dev - -## Platform Type - -`.mokostandards` platform: `joomla-template` or `waas-component` - -## Canonical Source - -This repo is the **single source of truth** for Joomla workflows and scaffolding. -Sync to production repos by copying `.gitea/workflows/` from here. - -## License - -GPL-3.0-or-later - Moko Consulting +GPL-3.0-or-later · Copyright © 2026 [Moko Consulting](https://mokoconsulting.tech) \ No newline at end of file