eclipsephp/plugin-template

Eclipse template for Filament plugins

v1.0.0 2025-03-21 09:17 UTC

This package is auto-updated.

Last update: 2025-05-02 13:01:11 UTC


README

Packagist PHP Version Support Packagist Version Packagist Downloads Tests codecov Conventional Commits Packagist License

About

This package serves as a Filament plugin template for plugins developed by DataLinx for Eclipse, our web app based on Filament. It is also a reference of how such a package should be configured.

The template is opinionated — it's based on our tech stack, which includes JetBrains PhpStorm.

This template works on and expands our PHP package template.

Requirements

  • PHP >= 8.2 (due to Pest 3 requirement)
  • Filament 3
  • Filament Shield plugin (to manage permissions)

See composer.json for details.

Getting started

  • Download it with composer:
  composer require eclipsephp/plugin-template
  • Provide a simple example how to use the package.

Contributing

Issues

If you have some suggestions how to make this package better, please open an issue or even better, submit a pull request.

Should you want to contribute, please see the development guidelines in the DataLinx PHP package template.

Development

Requirements

  • Linux, Mac or Windows with WSL
  • Lando (optional, but easier to start with)

Get started

  1. Clone the git repo
  2. Start the Lando container
  lando start
  1. Install dependencies (this also runs the setup composer script)
  lando composer install
  1. Happy coding 😉

Changelog

All notable changes to this project are automatically documented in the CHANGELOG.md file using the release workflow, based on the release-please GitHub action.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

For all this to work, commit messages must follow the Conventional commits specification, which is also enforced by a Git hook.