docs: update README with project overview and layer architecture

2026-06-21 23:22:58 +00:00
parent 5f13293004
commit e198187a8e
1 changed files with 21 additions and 60 deletions
@@ -1,70 +1,31 @@
-# Template-Joomla
+# MokoSuite Auto

-Unified scaffolding templates for all Joomla extension types.
+Auto dealership management for Joomla 6 — VIN inventory, sales deals, F&amp;I, trade-ins, test drives, financing, service department.

-## Structure
+**Layer 4** add-on for [MokoSuite](https://git.mokoconsulting.tech/MokoConsulting). Extends MokoSuiteERP + MokoSuitePOS.
+
+## Features
+
+- **Vehicle Inventory** — VIN lookup, lot management, aging report
+- **Sales Deals** — deal jacket, gross profit (front + back), F&amp;I products
+- **Trade-ins** — appraisal, equity calculation, negative equity rollover
+- **Test Drives** — scheduling, mileage check-out/in
+- **Financing** — loan calculator, term comparison, deal desking
+- **Service Dept** — repair orders, VIN history, dashboard
+
+## Layer Architecture

 ```
-.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
+Layer 0–3: Client → CRM → ERP → POS
+  └── Layer 4: MokoSuiteAuto ← this module
 ```

-## Usage
+## Helpers (6)

-1. Create a new repo from this template (or clone manually)
-2. Copy the relevant `types/<type>/` content to your project root
-3. Customize the manifest XML, namespace, and source files
-4. Workflows are already configured — push to trigger CI
+`VehicleHelper` · `DealHelper` · `TradeInHelper` · `TestDriveHelper` · `FinancingHelper` · `ServiceDeptHelper`

-## Shared Files
+## Links

-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
+- [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteAuto/wiki) · [Issues](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteAuto/issues) · [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteAuto/releases)

-## Workflow Suite (10 workflows)
-
-| 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)