README

About Larast

Larast is a Laravel starter kit with popular and essential packages pre-installed.

If you need a starter kit based on Filament, try Filamentum.

Installation

You can install Larast in two ways:

1. Via Laravel Installer

Create a new project using Laravel installer with Larast as the starter kit:

laravel new my-app --using=kanekescom/larast

2. Via Composer

You can install Larast in two ways:

a. Using Composer Create-Project:

composer create-project kanekescom/larast my-app

b. Clone from GitHub:

git clone https://github.com/kanekescom/larast.git my-app
cd my-app
composer install

After installation, your application will be ready with all the essential packages and configurations set up.

Creating a User

You can create default users with predefined roles by running the database seeder:

php artisan db:seed

This will create users with the following credentials and roles:

Name	Email	Role	Password
Super Admin User	superadmin@larast.com	Super Admin	password
Admin User	admin@larast.com	Admin	password
Regular User	user@larast.com	User	password

AI Coding Assistance

For developers using AI coding assistants, run the following command to install the MCP server and coding guidelines:

php artisan boost:install

This will set up the Model Context Protocol (MCP) server and configure coding guidelines that enhance your AI-assisted development experience.

Keeping Guidelines Up-to-Date

You may want to periodically update your local AI guidelines to ensure they reflect the latest versions of the Laravel ecosystem packages you have installed. To do so, you can use the boost:update Artisan command:

php artisan boost:update

You may also automate this process by adding it to your Composer "post-update-cmd" scripts:

{
  "scripts": {
    "post-update-cmd": [
      "@php artisan boost:update --ansi"
    ]
  }
}

Laravel Octane

This project comes with Laravel Octane pre-installed for high-performance serving of your Laravel application. To use Octane with FrankenPHP (the default server for this project), you need to run the installation command:

php artisan octane:install

When prompted, select "frankenphp" as your server.

After installation, you can start your application using Octane with:

php artisan octane:start

For more information about Laravel Octane configuration and usage, please refer to the official Laravel Octane documentation.

Running Tests

You can run the test suite using Composer:

composer test

This will execute all tests using PestPHP, which is configured as the default testing framework for this project.

Alternatively, you can run tests directly using the Artisan command:

php artisan test

Installed Packages

Filamentum comes with several pre-installed packages to help you build your application:

laravel/framework v12 - The core Laravel framework
laravel/octane v2 - High-performance Laravel application server
laravel/boost v1 - AI-assisted Laravel development experience
laravel/sail v1 - Docker setup for Laravel applications
laravel/telescope v5 - Debug assistant for Laravel
spatie/laravel-activitylog v4 - Activity logging for Laravel
spatie/laravel-backup v9 - Application & database backup tool
spatie/laravel-permission v6 - Roles and permissions management
spatie/laravel-query-builder v6 - Build Eloquent queries from API requests
pestphp/pest v4 - Elegant PHP testing framework
barryvdh/laravel-debugbar v3 - Debug bar for Laravel
barryvdh/laravel-ide-helper v3 - IDE helper files for Laravel

Recommended Additional Packages

To further enhance your Laravel application, consider adding these recommended packages:

laravel/horizon - Dashboard for Laravel queues
laravel/nightwatch - Application monitoring tool
laravel/passport - OAuth2 server for API authentication
laravel/sanctum - Authentication for SPAs and APIs
laravel/socialite - OAuth authentication with social networks
sentry/sentry-laravel - Error tracking and monitoring

Refer to each package's documentation for specific installation and configuration instructions.

License

Larast is open-sourced software licensed under the MIT license.

kanekescom / larast

Maintainers

Details