Laravel package to provide frontend template routes for non-production environments.
composer require fewfar/laravel-frontendThe package's service provider will be autoloaded on startup.
Next publish the templates and config file:
php artisan vendor:publish --provider="FewFar\LaravelFrontend\ServiceProvider"The files published this way are examples of structure and are not enforced by the package. Edit config/vendor/fewfar/frontend.php to change the paths of these files.
Add the following key to your .env file to enable the frontend routes (typically, local and staging):
FRONTEND_ENABLED=trueIf this key is already in use for your project, you can change this in the config/vendor/fewfar/frontend.php file.
Now you can visit /templates/ and see the templates.
Often within an app, it is useful to have view composers that load fallback variables from a configuration or the database when not provided by the controller explicitly. An example of this could be the page title in the HTML <head> for example. Depending on the setup you might not have a database defined when building the frontend templates, or you might not even want the database involved. In this case you still want your layout templates to recieve this variables, but it would be nice to hard code them for all the frontend templates.
To do this you can subclass the PageDefaultsViewComposer and add register it within a service provider:
<?php
namespace App\Providers;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;
use FewFar\LaravelFrontend\PageDefaultsViewComposer as BaseViewComposer;
class PageDefaultsViewComposer extends BaseViewComposer
{
/**
* Gets frontend default variables.
*
* @return array
*/
protected function defaultsForFrontend()
{
return [
'page' => [
'title' => 'HTML Meta Title',
'description' => 'HTML Meta Description',
...
],
];
}
/**
* Gets application default variables (i.e. ones used when not in the
* frontend templates.)
*
* @return array
*/
protected function defaultsForApp()
{
return [
'page' => [
'title' => config('app.name'),
...
],
];
}
}
<?php
namespace App\Http\ViewComposers;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;
use App\Http\ViewComposers\PageDefaultsViewComposer;
class ViewComposerServiceProvider extends ServiceProvider
{
/**
* Register bindings in the container.
*
* @return void
*/
public function boot()
{
// Here the 'app/' directory is assumed to be all the individual pages,
// and does not contain partials, or layouts. This is because the
// composer will be ran multiple times if the Blade template extends
// from files also in the 'app/' directory.
View::composer('app/*', PageDefaultsViewComposer::class);
}
}
This package uses Laravel Config Provider to allow you customise how we interact with config, you can find more details over there on how to customise it there.
This package provides a docker setup to develop and test itself. From the root of this directory you can run:
$ scripts/composer install
$ scripts/test
Laravel Frontend is open-sourced software licensed under the MIT license.