Get Started

Laravel Quickstart is a boilerplate for Laravel Application with typical packages preinstalled and configured to extend a full-fledged application. We tried to make it as minimal as possible.

Why it matters?

• Separate Views, Routes, Controllers directories for Frontend(Public Interface) and Backend(Admin Interface)
• Both Frontend and Backend utilizes TailwindCSSv3 as frontend framework
• Ready-made pages for Authentication/User Management/ Roles/Permission Management/ Log-viewer/ Notifications Management
• User Management Laravel Fortify package, with social login Socialite, API Authentication using Laravel Sanctum and Roles and Permissions Spatie Laravel Permissions package
• Integrated Log Viewer
• Integrated Laravel Debugbar as dev-dependency
• Preconfigured BrowserSync
• User Impersonation using Laravel Impersonate
• UUID Generator
• Breadcrumbs implementation using Laravel Breadcrumbs
• Icons Library using Laravel-Icons
• Event Listeners Implementation for Various User Events as example to encourage devs to implement more as required
• Multiple helper functions
• Useful Model Traits
• User Activity Log
• Multilingual Scaffolding
• User Timezone
• Implementation of User and Roles/Permission Factories and Seeders
• Least JavaScript (No jQuery) as we love working with AlpineJS
• Utilises SEO Tags (OpenGraph Facebook, Twitter Tags)
• Implementation and Scaffolding of SEO Tags using Google Tags Manager
• Progressive Web App (PWA) implementation out of the box
• Tailor-made plethora of laravel blade components to make your development life a breeze

We tried to bootstrap any requirement your application may have, yet we are open to discuss adding more.

Installation

1. Download Laravel-QuickStart

Choose your preferred method

• Download Zipped Archive.
• Clone from GitHub git clone https://github.com/developervijay7/laravel-quickstart.git

2. Setup .env file

Laravel-QuickStart has a .env.example file in the root of the project.

Rename .env.example to .env make sure that the .env file must be in root directory. Open .env file in your preferred choice of editor and add database credentials.

Database configuration

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_USERNAME=root
DB_PASSWORD=password

Also, don't forget to set up mail configuration.

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@laravel-quickstart.co"
MAIL_TO_ADDRESS="${APP_NAME}"

Note: Make sure your operating system is configured to display hidden files to show .env file.

3. Composer

In order to install php composer dependencies you first need to set up composer on your operating system. Once your system is compatible with php composer run the following command in your Terminal/ Windows Command Prompt/ Windows powershell/ git bash.

composer install

4. Generate Application Keys

This will set your APP_KEY in your .env file

php artisan key:generate

5. Migrate Database

php artisan migrate

if you also want to import demo users, permissions, and roles run:

php artisan db:seed

6. NPM/Yarn

In order to install JavaScript dependencies in your application you will need to install Node Package Manager and optionally you can use yarn to install them.

Once you have NPM installed run this command npm install

or if you want to install using yarn run: yarn

7. NPM run prod/dev

If you are deploying Laravel-QuickStart on your production environment run:

npm run build

If you are deploying it on your local development computer run:

npm run dev

8. Demo Credentials

For the purpose of demonstration we have seeded 3 users by default that are Master, Admin and User having roles assigned for them respectively. To add more refer to Spatie Permission Package Documentation here

Master: master@example.com

Password: Master@123

Admin: admin@example.com

Password: Admin@123

User: user@example.com

Password: User@123

Official Documentation

Laravel-QuickStart Documentation

Project Built Using Laravel-QuickStart

• Attrix Technologies Global
• Attrix Technologies India
• Vijay Goswami Developer Portfolio
• CollegeFind
• Pandit Sundarlal Sharma Central Institute of Vocational Education, Bhopal
• PSSCIVE, Bhopal - Staging Server
• Laravel-Icons
• TechnoVIJ Blog

Contributing

Thank you for considering contributing to the Laravel Quick-Start project! Please feel free to make any pull requests, or e-mail me a feature request you would like to see in the future to Vijay Goswami at hexpit@gmail.com.

License

The Laravel-QuickStart is open-sourced software licensed under the MIT license.

Star Gazers

Forkers