README

About this project

This is a laravel starter kit with all the necessary packages and configurations to start a new project.

Main packages used in this project:

• FilamentPHP
• Arcanedev Laravel Settings
• Spatie Permission
• Spatie Media Library
• Spatie Query Builder
• Filament date scopes filter
• Filament slim scrollbar
• Filament Image optimizer
• Filament themes
• Filament quick create
• Filament spatie laravel media library plugin
• Spatie laravel sitemap
• Filament tiptap editor
• Image optimizer
• Laravel easy enum
• Laravel easy metrics
• Spatie laravel responsecache
• Tailwind merge laravel

Dev dependencies used in this project:

• Laravel Debugbar
• Laravel ide-helper
• Laravel pint
• Pestphp
• Larastan
• Rector

Notes

If you want to set theme per user then you'll need to run the package migration. You can publish and run the migrations with:

php artisan vendor:publish --tag="themes-migrations"
php artisan migrate

You need to publish config file and change 'mode' => 'user' in order to set theme for user separately.

You can publish the config file with:

php artisan vendor:publish --tag="themes-config"

Usage

You can create a new project using composer create-project command:

composer create-project digiton-ma/laravel-starter-kit my-project

then run one of the setup scripts within the project directory:

cd my-project # if you are not already in the project directory
bash ./bin/setup.sh # if you get permission denied error
#or
php bin/setup.php

# for windows
./bin/setup.bat
#or
./bin/setup.ps1 # this one needs windows script execution permission, open powershell as admin and run this command: Set-ExecutionPolicy RemoteSigned

Or if you used the installer, you can create a new project by running:

digitoncli new my-project  --git --migrate --seed --github --org=digiton-ma

View the documentation for the installer for more information on the usage.

Tips

Max file upload size

If you encounter an error while uploading files, you may need to increase the maximum file upload size in your php.ini file. if the file you are trying to upload is larger than 120M and your php config supports more, then checkout media-library config file and change the max_file_size to the desired value, and livewire config file and change default max file size validation rule in temporary_file_upload -> rules from max:122880 to your desired size.

Main Features

FilamentPHP

FilamentPHP is a Laravel package that provides a simple and elegant way to build admin panels for your Laravel applications.

PWA Ready

This starter kit is PWA ready, you can start building your PWA right away. Go ahead and customize the manifest to make it your own. If you need a service worker feel free to create one for yourself. TODO: A service worker example.

Settings Management

using Spatie Laravel Settings to store settings in the database and retrieve them globally.

Permissions Management

using Spatie Permission to manage user permissions and roles.

Media Management and Optimization

using Spatie Media Library to manage media files and joshembling/image-optimizer to optimize images.

Themes Management (for filament panels only)

using hasnayeen/themes to manage themes for filament panels and aymanalhattami/filament-slim-scrollbar for slim scrollbar.

Extra forms and tables plugins

using filamentphp's plugins to add extra forms and tables features.

SEO Management

using spatie/laravel-sitemap to generate sitemap...

Caching Responses

using spatie/laravel-responsecache to cache responses.

Testing

using larastan and pest for testing

Code formatting

using laravel-pint for code formatting

Debugging

using laravel-debugbar for debugging

IDE Integration

using laravel-ide-helper for better IDE integration

Upcoming Features

• Payments Management: filament resource and front end urls for payments management or using plugins.
• Social Sign-in: using Google, Facebook, Twitter, and Github.
• Social Sharing: to easily share links from the project to social media.
• Social Media posts Integration: to get posts from social media accounts.
• Better Settings Management: to manage settings for different parts of the project, website information, email configs, social media links, navigation management and builders...
• Standard tests for all features using pest, like url tests, form tests and more.

Contributing

Thank you for considering contributing to this starter kit! The contribution guide can be found in the CONTRIBUTING.md.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Laravel's Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Abdelhamid Errahmouni via abdelhamid@digiton.ma, and feel free to create an issue. All security vulnerabilities will be promptly addressed.

License

This Starter kit is open-sourced software licensed under the MIT license.