Bootstrap
In filebootstrap/app.php
, you can setup route, global middlewares, redirects, expections, etc.
Usually you will not need to update anything unless you have specific global middlewares, api routes or other global settings.
Strict mode
By default, enables strict mode for Eloquent Models in non-production environment. If you want to disable strict mode then go toAppServiceProvider.php
and delete or comment this line of code.
What is strict mode?
- It prevents lazy loading (n+1 query problem)
- It prevents creating or updating non-fillable attributes (this kit uses
$guarded
instead, so this will not affect anything unless you start using$fillable
in Models) - and it prevents accessing missing attributes.
Why should I use strict mode?
It prevents silent data loss, catches typos early, ensures data integrity, and facilitates debugging, so it’s recommended to keep the strict more enabled.Polymorphic relationships
When using polymorphic relationships in Laravel you must save model name in database along with the ID. It’s good practice to map full class namespaces to readable strings. For exampleuser
instead of App\Models\User
.
You can achieve this by enforcing morph map in AppServiceProvider.php
. Or you can remove to keep using long names.
Models
As mentioned under Strict mode, uses$guarded
, instead of the default $fillable
property for mass assignment.
This prevents having bloated Models and allows seemless dynamic addition of new properties.
Instead, uses Form Requests to pass validated data on create or update of Eloquent Models, so it will never end up with bad data.
Here is an example of simple profile update using Form Request UpdateProfileRequest
. Only validated data from the request is being passed to the update()
method. This way we are in a total control of data so no need to explicitly define fillable properties.
Validation
By default, uses Form Requests and Policies to validate form data. You can follow an official Laravel docs on how to generate Policies and Form Requests. All the predefined core Policies can be found in/app/Policies
folder, while all the predefined Polices per module can be found under /modules/{name}/app/Policies
folder.
All the predefined core Form Requests can be found in /app/Http/Requests
folder, while all the predefined Form Requests per module can be found under /modules/{name}/app/Http/Requests
folder.
Authorization
When using form request for validation, you must implementauthorize
method which will allow or prevent further access, based on the rules.
Here you can use Policies or regular conditions.
This is the example from source code to check if users must be authenticated to create Roadmap posts.
Rules
When using form request for validation, you must implementrules
method which will define the validation rules.
You can define rules as string where validators are separated with pipe or as array of validators.
Here you can find the list of all available validators.
Messages
When using form request for validation, you can implementmessages
method where you can customize validation messages. By default, validation messages will use lang/en/validation.php
translation file.
To define the message for your rules you should use this format rule_name.validator_name
Input sanitizer
Package: https://github.com/elegantweb/sanitizer To use sanitizer in Form Request, you should first use theSanitizesInput
trait. Then define filters()
method where you can define sanitizer rules per input field.
Failed authorization
When using form request for validation, you can implementfailedAuthorization
method where you can customize message for failed authorization. By default, validation messages will be “This action is unauthorized”.
Shared props
Shared properties are available in every page and component via InertiausePage()
method or $page
variable. Read more about it here.
List of props
- app: contains common application props such as name, locale, settings, etc.
- flash: contains status, description and type of flash message
- modules: contains all the enabled modules
- legalPages: contains the link data of all legal pages
- auth: contains the data of authenticated user
Dynamic global props
Pass them via Controller to the view.- pageTitle: main title of the page (also used for tab title and fallback for meta titles)
- pageDescription: main description of the page (also used as fallback for meta descriptions)
- pageUrl: link to the page (used in
AdminLayout
only) - meta: meta data for SEO, see more here
Example
Here is example how to get authenticated user name from shared props using both:HandleInertiaRequests.php
, under share
method to view and/or update your shared props.
There is also type PageProps
for shared props in /resources/js/types/index.d.ts
which you can update accordingly.
Ziggy
Ziggy is package used to enable Laravel routes inside Vue. Routes are also available as shared prop. Routes are initialized in file/resources/views/app.blade.php
using the blade rule @routes
, which uses the settings from this file /config/ziggy.php
. Feel free to update it by your project requirements.
By default, all routes are available except admin area routes, which are only available once the Admin has logged in.
Slugs
Spatie Sluggable is package used to enable slug creation for pretty URLs certain Models like blog posts and tags. To enable slugs you should use theSpatie\Sluggable\HasSlug
trait and the Spatie\Sluggable\SlugOptions
class on your Eloquent Model.
You should also add a field to Model’s table where generated slug will be saved.
Media uploads
Spatie Media Library is package used to provide image uploads. You can update the settings here:config/media-library.php
.Default settings are usually good enough. To enable image uploads you should implement
Spatie\MediaLibrary\HasMedia
interface and use the App\Traits\HasMediaUploads
trait on your Eloquent Model.
Then you should register your media collecions and conversions.The example below creates
cover
media for blog post with thumbnail
and small
image.
addMediaCollection
: Defines the collection name.useDisk
: Defines the disk name.singleFile
: There will always be just one file uploaded.registerMediaConversions
: Resized variants of original file. Read more in official docs.
Method
uploadImage
is defined in the trait HasMediaUploads
where you can check it’s definition.
It accepts four parameters:
UploadedFile|string $fileOrPath
: Uploaded image file or path to the image.string $mediaCollection
: Name of the media collection which you want to process. Defaults tocover
.string $diskName
: Storage disk name. Defaults to empty string and uses the disk defined withuseDisk
chained method. You can set this parameter to override the default disk. You can use custom local storage or external storage. All disks are defined inconfig/filesystems.php
.bool $public = true
: File will be publicly visible when true. This is usually used when uploading files to remote disks.
Storage (disks)
By default, there are two local disks:public
(/storage) and avatars
(/storage/avatars), and one external disk: s3
.
You can update those disks, delete them (if you delete them you will need to update the code using those disks) or create new local or external disks (MinIO, DigitalOcean Spaces, etc.).
Local public disks
To make files accessible from the web, you should create a symbolic link from yourpublic/storage
folder to the disk storage location. You can do this by running this terminal command:
AWS S3
To configure S3 driver as your storage, follow the official Laravel docs.Translations
At the moment, starter kit supports one language out of the box. Default language is english. To change default locale, setAPP_LOCALE
in .env
file to desired locale.
en.json
file and en
folder in /lang
, rename them to your new locale and adjust the translations.
Localization
If you want to add localization to your application, you can do it using the Laravel Localization package. You will also need to handle Model translations using other packages or custom.Pre-configured localization with translatable Models will be available with
v2.
Sitemap
app/Console/Commands/GenerateSitemap.php
Generate sitemap.xml
file for your application.
Sitemap command is triggered daily, which you can update here routes/console.php
.
To run scheduled commands your should setup the
queue on your
server.
Server side rendering
To build file for SSR, first run this command to generate routes:Local development
Run this command in your terminal. This will start the SSR on port13714
.
url
in config file config/inertia.php
and pass the port number as second prop to createServer
method in resources/js/ssr.ts
file.