Skip to content
/ plugin-skeleton Public template

Basic skeleton for a HydePHP Composer plugin

License

Notifications You must be signed in to change notification settings

hydephp/plugin-skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

My HydePHP Package Name

This basic starter skeleton for a HydePHP Composer plugin is designed for you to use as a starting point for your own HydePHP Composer plugin. It's quite minimal by design, as what you will need for your package will depend on what kind of package you are building.

Start by using the repository template feature on GitHub to create a new repository from this template. Then clone your new repository to your local machine and start building your package.

If you need help, please feel free to ask for help in the HydePHP Discord or the GitHub Developer Discussions.

General development tips:

  • Read the Extensions API documentation at https://hydephp.com/docs/1.x/extensions-api
  • Since HydePHP is based on Laravel, the packages work similarly. You most likely will want to use a service provider to register information. If you need access to the discovery process (for example, if you add a new page type), you'll want to use the Extensions API. As long as your provider class is registered in the composer.json file, your plugin can be enabled automatically when installed.

Tip: Why not deploy your package documentation using HydePHP?


Installation

You can install the package via Composer:

composer require vendor/package-name

Usage

You can use this package by doing something:

use Vendor\PackageName\Inspire;

function beInspired(): {
  return Inspire::workMagick();
}

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review the security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.

About

Basic skeleton for a HydePHP Composer plugin

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages