https://github.com/hydephp/plugin-skeleton
Basic skeleton for a HydePHP Composer plugin
https://github.com/hydephp/plugin-skeleton
Last synced: 6 months ago
JSON representation
Basic skeleton for a HydePHP Composer plugin
- Host: GitHub
- URL: https://github.com/hydephp/plugin-skeleton
- Owner: hydephp
- License: mit
- Created: 2024-02-02T16:58:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T15:51:35.000Z (almost 2 years ago)
- Last Synced: 2025-03-26T17:51:59.135Z (10 months ago)
- Language: PHP
- Size: 38.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://discord.hydephp.com) or the [GitHub Developer Discussions](https://github.com/hydephp/develop/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:
```bash
composer require vendor/package-name
```
## Usage
You can use this package by doing something:
```php
use Vendor\PackageName\Inspire;
function beInspired(): {
return Inspire::workMagick();
}
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review the [security policy](../../security/policy) on how to report security vulnerabilities.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.