Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/considbrs-webdev/modularity-municipal-calendar/archive/refs/heads/main.zipOn Packagist as considbrs-webdev/modularity-municipal-calendar:
composer require considbrs-webdev/modularity-municipal-calendarNo built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
A municipal-calendar module
Getting Started
- Clone this repository
- Run
composer installto install PHP dependencies - Run
npm installto install Node dependencies - Run
npm run buildto build assets
Development
npm run dev- Start development servernpm run watch- Watch for changes and rebuildnpm run build- Build for productioncomposer test- Run PHP testscomposer lint- Lint PHP codecomposer format- Format PHP code
Structure
├── modularity-municipal-calendar.php # Main plugin file
├── source/
│ ├── php/
│ │ ├── App.php # Application bootstrap
│ │ ├── AcfFields/ # ACF field definitions
│ │ └── Module/ # Module classes
│ │ ├── MunicipalCalendar.php # Main module class
│ │ ├── assets/ # Module assets (icons)
│ │ └── views/ # Blade templates
│ └── sass/ # SCSS files
├── assets/ # Compiled assets (generated)
└── languages/ # Translation files
Creating Your Module
- Rename
modularity-municipal-calendar.phpand update the plugin header - Update the namespace in
composer.jsonand all PHP files - Rename
source/php/Module/MunicipalCalendar.phpto your module name - Update ACF fields in
source/php/AcfFields/json/ - Customize views in
source/php/Module/views/ - Add styles in
source/sass/
License
MIT