schoolpalm/module-sdk

Official SDK for building SchoolPalm modules

1.5.0 2025-12-31 14:12 UTC

Requires

• php: ^8.2
• illuminate/console: ^12.0
• illuminate/support: ^12.0
• inertiajs/inertia-laravel: ^2.0
• opis/json-schema: ^2.6
• schoolpalm/module-bridge: dev-main

Suggests

• @inertiajs/inertia-vue3: JS Vue3 adapter for Inertia
• quasar: Quasar framework for UI components
• vue: Vue3 for module frontend

MIT

• Hassan Mugabo

README

Official SDK for building SchoolPalm modules.

Installation

Install the package via Composer:

composer require schoolpalm/module-sdk

Requirements

• PHP ^8.2
• Laravel ^12.0
• Inertia.js ^2.0

Usage

This SDK provides tools and scaffolding for creating SchoolPalm modules. It includes console commands for generating modules, validating manifests, and more.

Console Commands

1. php artisan sp:make-m <name> – Create a new module
2. php artisan sp:validate-m – Validate a module manifest
3. php artisan sp:gen-s – Generate folder structure for module development
4. php artisan sp:stub – Generate all stubs

Module Structure

Modules should follow the structure defined in the SDK. Use the provided generators to scaffold new modules.

For more detailed documentation, refer to the SchoolPalm Documentation.

Contributing

Contributions are welcome! Please see the contributing guidelines for details.

License

This package is open-sourced software licensed under the MIT license.