README

About

Filament plugin for world data.

✅ Countries
🟧 Geo and special regions (WIP)
🟧 Posts (WIP)
⏳ Other resources coming when needed (suggest a feature and/or hire us)

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/world-plugin

• If you want to use the emoji picker for the country flag, also install the Emoji Picker plugin.

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

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

• 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

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-world-plugin.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.

💡 To manually test the plugin in the browser, see our recommendation, which is also how Filament suggests package development.
However, the plugin should be universal and not dependent on our app setup or core package.

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.