spomky-labs/pwa-bundle

Progressive Web App Manifest Generator Bundle for Symfony.

1.1.5 2024-04-22 18:08 UTC

Requires

• php: >=8.2
• phpdocumentor/reflection-docblock: ^5.3
• symfony/asset-mapper: ^6.4|^7.0
• symfony/config: ^6.4|^7.0
• symfony/dependency-injection: ^6.4|^7.0
• symfony/http-kernel: ^6.4|^7.0
• symfony/property-access: ^6.4|^7.0
• symfony/property-info: ^6.4|^7.0
• symfony/routing: ^6.4|^7.0
• symfony/serializer: ^6.4|^7.0
• twig/twig: ^3.8

Requires (Dev)

• dbrekelmans/bdi: ^1.1
• infection/infection: ^0.28
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.0
• phpstan/phpstan-beberlei-assert: ^1.0
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpstan/phpstan-strict-rules: ^1.0
• phpunit/phpunit: ^10.1
• rector/rector: ^1.0
• symfony/filesystem: ^6.4|^7.0
• symfony/framework-bundle: ^6.4|^7.0
• symfony/mime: ^6.4|^7.0
• symfony/panther: ^2.1
• symfony/phpunit-bridge: ^6.4|^7.0
• symfony/translation: ^7.0
• symfony/yaml: ^6.4|^7.0
• symplify/easy-coding-standard: ^12.0

Suggests

• ext-gd: Required to generate icons (or Imagick).
• ext-imagick: Required to generate icons (or GD).
• symfony/filesystem: For generating and manipulating icons or screenshots
• symfony/mime: For generating and manipulating icons or screenshots
• symfony/panther: For generating screenshots directly from your application

MIT

• Florent Morselli
• All contributors

• symfony
• bundle
• pwa
• symfony-ux

README

Scope

This bundle provides the Spomky-Labs/pwa-bundle bundle for Symfony. This will help you to generate Progressive Web Apps (PWA) Manifests and assets (icons or screenshots). Also, it will help you to generate Service Workers based on Workbox.

Please have a look at the Web app manifests for more information about Progressive Web Apps.

Installation

Install the bundle with Composer:

composer require spomky-labs/pwa-bundle

If you want to use the commands to generate icons and screenshots, install the necessary dependencies:

composer require symfony/panther dbrekelmans/bdi symfony/mime symfony/filesystem --dev
vendor/bin/bdi detect drivers
bin/console pwa:create:icons --help

This project follows the semantic versioning strictly.

Documentation

The documentation is available at https://pwa.spomky-labs.com/

Support

I bring solutions to your problems and answer your questions.

If you really love that project and the work I have done or if you want I prioritize your issues, then you can help me out for a couple of 🍻 or more!

• Become a sponsor
• Become a Patreon
• Buy me a coffee

Contributing

Requests for new features, bug fixed and all other ideas to make this project useful are welcome. The best contribution you could provide is by fixing the opened issues where help is wanted.

Please report all issues in the main repository.

Please make sure to follow these best practices.

Security Issues

If you discover a security vulnerability within the project, please don't use the bug tracker and don't publish it publicly. Instead, all security issues must be sent to security [at] spomky-labs.com.

Licence

This project is release under MIT licence.