README

Introduction

Laravel Starter Base App Kit is a boilerplate for starting new Laravel projects with a pre-configured setup for code quality tools, environment configuration, and essential packages. This kit aims to streamline the development process by providing a solid foundation for building robust and maintainable Laravel applications.

Installation

To create a new project using this starter kit, run the following command:

default with jetstream

composer create-project lightszentip/laravel-starter-base-app

filamentphp

composer create-project lightszentip/laravel-starter-base-app:dev-filamentphp

Setup

After creating the project, navigate to the project directory and set up your environment:

cd laravel-starter-base-app
cp .env.example .env

Run the database migrations and seeders:

php artisan migrate
php artisan db:seed

Features

• Pre-configured Code Quality Tools: Includes Pint, Larastan, PHPMD, PSALM, and PHPCodeSniffer.
• Environment Configuration: Easy setup for environment variables.
• Essential Packages: Pre-installed packages for security, static analysis, and more.

Code Quality Tools

This starter kit comes with several code quality tools pre-configured:

• Pint: Pint Workflow
• Larastan: Larastan Workflow
• PHPMD: PHPMD Workflow
• PSALM: PSALM Workflow
• PHPCodeSniffer: PHPCodeSniffer Workflow

Usage

Running Code Quality Tools

To run the code quality tools, use the following commands:

• Pint: ./vendor/bin/pint
• Larastan: ./vendor/bin/phpstan analyse
• PHPMD: ./vendor/bin/phpmd app text phpmd.ruleset.xml
• PSALM: ./vendor/bin/psalm
• PHPCodeSniffer: ./vendor/bin/phpcs

Environment Configuration

Configure your environment variables in the .env file. Here are some key settings:

• APP_NAME: The name of your application.
• APP_ENV: The environment your application is running in (local, production, etc.).
• APP_KEY: The application key (use php artisan key:generate to generate one).
• DB_CONNECTION: The database connection type (e.g., mysql).
• DB_HOST: The database host.
• DB_PORT: The database port.
• DB_DATABASE: The database name.
• DB_USERNAME: The database username.
• DB_PASSWORD: The database password.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss your ideas.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

For any issues or questions, please open an issue on the GitHub repository.