cabinetoffice/laravel-breeze-govuk-frontend

A Laravel Breeze scaffolding for GOV.UK Frontend

v0.5.4 2022-09-27 16:13 UTC

Requires

• php: ^7.3|^8.0
• ext-json: *
• illuminate/filesystem: >=8.0
• illuminate/support: >=8.0
• laravel/breeze: >=0.1.0

Requires (Dev)

• orchestra/testbench: >=4.0
• phpunit/phpunit: >=8.0

MIT

• Digital Communication, Cabinet Office and Number 10 Digital (MS)

• ui
• Authentication
• template
• design
• laravel
• government
• breeze
• design system
• govuk
• cabinetoffice
• laravel-breeze-govuk-frontend

README

A Laravel Breeze scaffolding for GOV.UK Frontend.

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

See live examples of GOV.UK Frontend components, and guidance on when to use them in your service, in the GOV.UK Design System.

The version of GOV.UK Frontend used: 3.10.0

Usage

1. Fresh install Laravel and cd to your app directory.
2. Install this package via composer require cabinetoffice/laravel-breeze-govuk-frontend --dev. Laravel will automatically discover this package. You do not need to register the service provider.
3. Use php artisan breeze:install-govuk to install. See note about error from Laravel Breeze below.
4. npm install && npm run dev
5. You may need to carry out additional configurations and database migration depending on your set up.
6. php artisan serve to run server and test.

Note: Dealing with Laravel Breeze installation error

This package installs Laravel Breeze as part of its installation. If Laravel Breeze generates error this will be flagged and installation of this package will stop. You can ignore errors generated by Laravel Breeze and keep on installing by using --ignoreBreezeError=true option with the install command, i.e. you would run: php artisan breeze:install-govuk --ignoreBreezeError=true.

GOV.UK Preset for Laravel UI (old Laravel UI version)

Laravel 6.0+/7.0+ UI/frontend preset for GOV.UK Frontend, without Laravel Breeze

There are a couple of packages from us, available at https://packagist.org/packages/cabinetoffice/laravel-govuk-frontend-preset.

Maintainers

The package has been developed by Digital Communication, Cabinet Office and No10 Communication.

Contributing

If you want to contribute, please do so with a pull request.

Security Vulnerabilities

If you discover vulnerability with this package, please send an email to [e-mail].

If you discover a security vulnerability within Laravel, please send an email to Taylor Otwell at [e-mail].

Licence

Unless stated otherwise, the codebase is released for this package is under the MIT License. The licence for the GOV.UK Frontend codebase and documentation is available at: GOV.UK Frontend licence