Skip to content

README.md

Latest commit

 

History

History
91 lines (64 loc) · 3.39 KB

README.md

File metadata and controls

91 lines (64 loc) · 3.39 KB
Raw

Eclipse common package

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

About

This package contains all common non-opinionated code that is used in our Eclipse Filament plugins.

Requirements

  • PHP 8.3 / 8.4 / 8.5
  • Laravel 11 / 12
  • Filament 5
  • Laravel Scout

See composer.json for details.

Usage

  composer require eclipsephp/common

Contributing

Issues

If you have some suggestions on 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

  1. All development is subject to our PHP package development guidelines.
  2. Our Filament app development docs will also be helpful.
  3. Any PRs will generally need to adhere to these before being merged.

Requirements

See here.

Get started

  1. Clone the git repo
  2. Start the Lando container 
    lando start
  3. Install dependencies (this also runs the setup composer script) 
    lando composer install
  4. You can now develop and run tests. Happy coding 😉

Workbench + Lando (browser testing)

This package ships with a minimal Testbench Workbench, so you can run the Filament UI without a separate app:

  1. Clone the repository

  2. Start the container

    lando start

  3. Open the admin panel at https://eclipse-plugin-template.lndo.site/admin

No login required – you'll be automatically signed in as a test user with full permissions.

Notes:

  • The container serves workbench/public as the webroot.
  • Use lando test for package:test and lando testbench for other Testbench commands.
  • No Telescope, websockets or health checks are enabled to keep the setup minimal.

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.