This project serves as a starter kit for Laravel applications, providing a skeleton structure with essential packages and configurations to kickstart your development process.
The project relies on the following dependencies:
- laravel/breeze: A minimalistic authentication system for Laravel.
- laravel/pulse: A performance monitoring tool for Laravel applications (beta version).
- spatie/laravel-backup: A package to backup your Laravel app.
- spatie/laravel-login-link: Generate temporary signed URLs to login without a password.
- spatie/laravel-sitemap: Generate sitemaps dynamically.
- fakerphp/faker: A library for generating fake data.
- laravel/pint: A package to manage your database migrations efficiently.
- laravel/sail: Docker development environment for Laravel.
- laravel/telescope: An elegant debug assistant for Laravel.
- mockery/mockery: A simple yet flexible PHP mock object framework.
- nunomaduro/collision: Error handling for console/command-line PHP applications.
- nunomaduro/larastan: A PHPStan wrapper for Laravel applications.
- pestphp/pest: Elegant testing framework for PHP.
- pestphp/pest-plugin-laravel: Laravel plugin for Pest.
- spatie/laravel-ignition: A powerful error page for Laravel.
Follow these steps to set up the Laravel Starter Kit on your local machine:
-
Clone the repository:
git clone https://github.com/vcjpierre/laravel-starter-kit.git
-
Navigate to the project directory:
cd laravel-starter-kit
-
Install Composer dependencies:
composer install
-
Install NPM dependencies:
npm install && npm run dev
-
Configure Environment:
- Create a copy of the
.env.example
file and name it.env
. - Generate an application key:
php artisan key:generate
- Create a copy of the
-
Set up the Database:
- Ensure your database credentials are correctly set in the
.env
file. - Create and migrate the database:
php artisan migrate
- Ensure your database credentials are correctly set in the
-
Run the Development Server:
php artisan serve
-
Access the Application: Open your web browser and navigate to
http://localhost:8000
to access the Laravel Starter Kit.
- Explore the
routes
,app
, andresources
directories to understand the project structure. - Refer to Laravel documentation for detailed information on using specific features and packages.
Happy coding with Laravel! 🚀