Laravel Starter is a Laravel 11.x based simple starter project. Most of the commonly needed features of an application like Authentication
, Authorisation
, Users
and Role management
, Application Backend
, Backup
, Log viewer
are available here. It is modular, so you may use this project as a base and build your own modules. A module can be used in any Laravel Starter
based project.
Here Frontend and Backend are completely separated with separate routes, controllers, and themes as well.
Please let me know your feedback and comments.
If you discover any security-related issues, please send an e-mail to Nasir Khan Saikat via [email protected] instead of using the issue tracker.
Check the following demo project. It is just a straight installation of the project without any modification.
Demo URL: https://laravel.nasirkhn.com
You may use the following account credentials to access the application backend.
User: [email protected]
Pass: secret
User: [email protected]
Pass: secret
If you want to test the application on your local machine with additional demo data you may use the following command.
php artisan laravel-starter:insert-demo-data
There are options to truncate the posts, categories, tags, and comments
tables and insert new demo data.
--fresh
option will truncate the tables, without this command a new set of data will be inserted.
php artisan laravel-starter:insert-demo-data --fresh
We have created a number of custom commands for the project. The commands are listed below with a brief about their use of it.
To create a project use the following command, you have to replace the MODULE_NAME with the name of the module.
php artisan module:build MODULE_NAME
You may want to use --force
option to overwrite the existing module. if you use this option, it will replace all the existing files with the default stub files.
php artisan module:build MODULE_NAME --force
composer clear-all
this is a shortcut command to clear all cache including config, route, and more
We are now using Laravel Pint
to make the code style stay as clean and consistent as the Laravel Framework. Use the following command to apply CS-Fix.
composer pint
Several custom commands are available to add and update role-permissions
. Please read the Role - Permission Wiki page, where you will find the list of commands with examples.
The Laravel Starter
comes with several features which are the most common in almost all applications. It is a template project which means it is intended to be built in a way that it can be used for other projects.
It is a modular application, and some modules are installed by default. It will be helpful to use it as a base for future applications.
- Admin feature and public views are completely separated as
Backend
andFrontend
namespace. - Major features are developed as
Modules
. A module like Posts, Comments, and Tags are separated from the core features like User, Role, Permission
- User Authentication
- Social Login
- Github
- Build in a way adding more is much easier now
- User Profile with Avatar
- Role-Permissions for Users
- Dynamic Menu System
- Language Switcher
- Localization enabled across the project
- Backend Theme
- Bootstrap 5, CoreUI
- Fontawesome 6
- Dark Mode
- Frontend Theme
- Tailwind
- Fontawesome 6
- Dark Mode
- Article Module
- Posts
- Categories
- Tags
- Comments
- wysiwyg editor
- File browser
- Application Settings
- External Libraries
- Bootstrap 5
- Fontawesome 6
- CoreUI
- Tailwind
- Datatables
- Select2
- Date Time Picker
- Backup (Source, Files, Database as Zip)
- Log Viewer
- Notification
- Dashboard and details view
Follow the steps mentioned below to install and run the project. You may find more details about the installation in Installation Wiki.
- Open the terminal and run the following command, this will download and install the
Laravel Starter
and run the post-installation commands.
composer create-project nasirkhan/laravel-starter
- The default database is
sqlite
, if you want to change please update the database settings at.env
file - To create a link from the storage directory, run the following command from the project root:
php artisan storage:link
- If you run the
create-project
command fromLaravel Hard
then the site will be available at https://laravel-starter.test. You may create a virtualhost entry to access the application or runphp artisan serve
from the project root and visithttps://127.0.0.1:8000
After creating the new permissions use the following commands to update cashed permissions.
php artisan cache:forget spatie.permission.cache
This project is configured with Laravel Sail (https://laravel.com/docs/sail). You can use all the docker functionalities here. To install using docker and sail:
- Clone or download the repository
- Go to the project directory and run
composer install
- Create
.env
file by copying the.env-sail
. You may use the command to do thatcp .env-sail .env
- Update the database name and credentials in
.env
file - Run the command
sail up
(consider adding this to your alias:alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'
) - Run the command
sail artisan migrate --seed
- Link storage directory:
sail artisan storage:link
- Since Sail is already up, you can just visit https://localhost:80
Home Page
Login Page
Posts Page
Backend Dashboard