Skip to content

This skeleton is served as the foundation template of the ModulesPress framework plugin structure. πŸ“‚

Notifications You must be signed in to change notification settings

devsroutes/modulespress-skeleton

Repository files navigation

ModulesPress Skeleton πŸš€

ModulesPress Logo

A modern WordPress plugin development framework inspired by NestJS, Angular, and Laravel.

🌟 Overview

ModulesPress Skeleton provides a robust foundation for building scalable and maintainable WordPress plugins using modern development practices. This template serves as the starting point for your ModulesPress-based plugins.

✨ Features

  • 🎯 Modern Architecture - NestJS-inspired modular design
  • πŸš€ TypeScript & React - First-class support for modern frontend
  • πŸ› οΈ PHP 8+ Attributes - Use decorators for clean, declarative code
  • πŸ“¦ Dependency Injection - Powerful DI container for better testing
  • πŸ”’ Type Safety - Full TypeScript and PHP type support
  • ⚑ Vite Integration - HMR and modern build tools
  • 🎨 Blade Templates - Elegant templating with Laravel's Blade

πŸ“‹ Prerequisites

  • PHP 8.1 or higher
  • WordPress 6.0 or higher
  • Node.js 16 or higher
  • Composer

πŸš€ Quick Start

  1. Install ModulesPress CLI:

    composer global require modulespress/cli
  2. Create a new plugin:

    modulespress new
    // or
    mp new
  3. Start development:

    npm run dev

πŸ“ Project Structure

plugin-name/
β”œβ”€β”€ .cache/              # Cache storage (views, compiled templates)
β”œβ”€β”€ artifacts/           # Compiled and packaged plugin versions as zip files
β”œβ”€β”€ build/               # Compiled Vite assets
β”œβ”€β”€ resources/           # Source assets requiring compilation
β”œβ”€β”€ src/                 # PHP source code
β”œβ”€β”€ static/              # Uncompiled/raw assets
β”œβ”€β”€ vendor/              # Composer dependencies
β”œβ”€β”€ node_modules/        # NPM dependencies
└── views/               # Blade template files
└── plugin.php           # Plugin main file

πŸ“„ License

This project is licensed under the MIT License.

About

This skeleton is served as the foundation template of the ModulesPress framework plugin structure. πŸ“‚

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published