Clone
1
templates-generic
Jonathan Miller edited this page 2026-05-20 01:26:23 +00:00

← Back to Home

Template-Generic Reference

Generic project template conforming to MokoStandards. Starting point for any new PHP, Node.js, or general-purpose coding project within the Moko Consulting organization.


Type General-Purpose Template
Language PHP / Node.js / Any
License GPL-3.0-or-later
Repo Template-Generic
Wiki Template-Generic wiki

Purpose

Template-Generic gives every new project a consistent foundation that meets MokoStandards out of the box. It includes standardized directory layout, a Makefile build system with automatic PHP/Node.js detection, nine CI/CD workflows, and full governance scaffolding.

What the Template Provides

Component Description
Directory layout src/, .gitea/, standard root files
Makefile Targets for lint, test, build, package, release -- auto-detects PHP (Composer) or Node.js (npm)
CI/CD workflows 9 Gitea Actions workflows covering the full project lifecycle
MokoStandards manifest .gitea/.mokostandards XML for platform tooling
.gitignore Multi-language coverage (PHP, Node.js, Python, OS/editor)
Documentation scaffolding INSTALLATION guide, README template, SFTP config template
License GPL-3.0-or-later with Moko Consulting copyright

Quick Start

  1. Click Use this template on the Template-Generic repo
  2. Update project metadata:
File Update
.gitea/.mokostandards <name>, <description>, <language>, <platform>
Makefile PROJECT_NAME and PROJECT_VERSION
README.md Replace template content
docs/INSTALLATION.md Fill in placeholder sections
  1. Add source code to src/ and build:
make install-deps    # Install Composer and/or npm dependencies
make validate        # Run linters and coding standards checks
make test            # Run tests
make build           # Build for production
make package         # Create distribution packages

Workflows

Workflow Trigger Purpose
auto-release.yml Merge to main Tag release, build packages, publish artifacts
pre-release.yml Push to dev Validation and pre-release builds
pr-check.yml Pull request Lints, tests, validates the PR
security-audit.yml Schedule/push Dependency vulnerability scanning
repo-health.yml Schedule Structure and standards compliance
cleanup.yml Schedule Prune stale branches and artifacts
deploy-manual.yml Manual Deploy specific version to target environment
notify.yml Release created Event notifications
update-server.yml Release created Publish update manifest

Directory Structure

Template-Generic/
|-- .gitea/
|   |-- .mokostandards          # MokoStandards governance manifest
|   +-- workflows/              # 9 CI/CD workflows
|-- docs/
|   |-- INSTALLATION.md         # Installation guide template
|   +-- templates/
|       |-- README-template.md  # Standard README format
|       +-- sftp-config.json.template  # Sublime SFTP config
|-- src/                        # Source code directory
|-- .gitignore                  # Multi-language gitignore
|-- LICENSE                     # GPL-3.0-or-later
|-- Makefile                    # Build system (PHP + Node.js)
+-- README.md

Key Wiki Pages

Page Description
Installation Installation and setup guide
README Template Standard README format for new projects
Templates Index Index of included documentation templates


Repo: moko-platform · moko-platform wiki

Field Value
Minimum Version 04.07.00
Platform all
Applies To General-purpose repositories
Revision Date Author Description
1.0 2026-05-19 Moko Consulting Initial version