Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/developervijay7/laravel-quickstart
Laravel Quick-Start is a boilerplate for Laravel Application with typical packages preinstalled and configured.
https://github.com/developervijay7/laravel-quickstart
alpinejs boilerplate-template laravel laravel-livewire tailwindcss tall-stack
Last synced: 28 days ago
JSON representation
Laravel Quick-Start is a boilerplate for Laravel Application with typical packages preinstalled and configured.
- Host: GitHub
- URL: https://github.com/developervijay7/laravel-quickstart
- Owner: developervijay7
- License: mit
- Created: 2022-03-16T05:30:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T13:41:26.000Z (7 months ago)
- Last Synced: 2024-11-25T18:24:51.736Z (about 2 months ago)
- Topics: alpinejs, boilerplate-template, laravel, laravel-livewire, tailwindcss, tall-stack
- Language: PHP
- Homepage: https://laravel-quickstart.com
- Size: 4.16 MB
- Stars: 44
- Watchers: 7
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 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](https://tailwindcss.com/) as frontend framework
- Ready-made pages for Authentication/User Management/ Roles/Permission Management/ Log-viewer/ Notifications Management
- User Management [Laravel Fortify](https://github.com/laravel/fortify) package, with social login [Socialite](https://github.com/laravel/socialite), API Authentication using [Laravel Sanctum](https://github.com/laravel/sanctum) and Roles and Permissions [Spatie Laravel Permissions](https://github.com/spatie/laravel-permission) package
- Integrated [Log Viewer](https://github.com/ARCANEDEV/LogViewer)
- Integrated [Laravel Debugbar](https://github.com/barryvdh/laravel-debugbar) as dev-dependency
- Preconfigured [BrowserSync](https://browsersync.io/)
- User Impersonation using [Laravel Impersonate](https://github.com/404labfr/laravel-impersonate)
- [UUID Generator](https://github.com/ramsey/uuid)
- Breadcrumbs implementation using [Laravel Breadcrumbs](https://github.com/tabuna/breadcrumbs)
- [Icons Library](https://laravel-icons.com) using [Laravel-Icons](https://github.com/developervijay7/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](https://github.com/spatie/laravel-activitylog)
- Multilingual Scaffolding
- User [Timezone](https://github.com/jamesmills/laravel-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](https://tagmanager.google.com)
- 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](https://github.com/developervijay7/laravel-quickstart/archive/refs/heads/main.zip).
- 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
```dotenv
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.
```dotenv
MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="[email protected]"
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](https://spatie.be/docs/laravel-permission/v5/introduction)
Master: [email protected]
Password: Master@123
Admin: [email protected]
Password: Admin@123
User: [email protected]
Password: User@123
## Official Documentation
[Laravel-QuickStart Documentation](http://docs.laravel-quickstart.com)
## Project Built Using Laravel-QuickStart
- [Attrix Technologies Global](https://www.attrixtech.com)
- [Attrix Technologies India](https://www.attrixtech.in)
- [Vijay Goswami Developer Portfolio](https://vijaygoswami.in)
- [CollegeFind](https://collegefind.in)
- [Pandit Sundarlal Sharma Central Institute of Vocational Education, Bhopal](http://psscive.ac.in)
- [PSSCIVE, Bhopal - Staging Server](https://psscive.in)
- [Laravel-Icons](https://laravel-icons.com)
- [TechnoVIJ Blog](https://technovij.com)
## 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 [[email protected]](mailto:[email protected]).
## License
The Laravel-QuickStart is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
## Star Gazers
[](https://github.com/developervijay7/laravel-quickstart/stargazers#gh-light-mode-only)
[](https://github.com/developervijay7/laravel-quickstart/stargazers#gh-dark-mode-only)
## Forkers
[](https://github.com/developervijay7/laravel-quickstart/network/members#gh-light-mode-only)
[](https://github.com/developervijay7/laravel-quickstart/network/members#gh-dark-mode-only)