README

A comprehensive starter template for creating high-quality Laravel packages with modern development tools and best practices.

📋 Table of Contents

• Overview
• Features
• Requirements
• Installation
• Quick Start
• Development Workflow
• Testing
• Code Quality
• Contributing
• Changelog
• License
• Support

🎯 Overview

This template provides a solid foundation for developing Laravel packages with industry-standard tools and configurations. It follows Laravel package development best practices and includes everything you need to create, test, and maintain professional-grade packages.

✨ Features

• 🧪 Comprehensive Testing Suite

  • PestPHP for Feature, Unit & Architecture testing
  • Laravel Workbench for integration testing
  • Pre-configured test environments

• 🔧 Code Quality Tools

  • Laravel Pint for consistent code styling
  • Rector for automated refactoring and upgrades
  • GitHub Actions for continuous integration

• 📦 Package Development Tools

  • Pre-configured composer.json with optimal settings
  • Service provider boilerplate
  • Configuration and migration publishing

• 🚀 Developer Experience

  • Automated CI/CD workflows
  • Development helper commands
  • Documentation templates

📋 Requirements

• PHP 8.1 or higher
• Laravel 10.0 or higher
• Composer 2.0 or higher

🚀 Installation

Using GitHub Template

1. Click the "Use this template" button on the GitHub repository
2. Create your new repository
3. Clone your new repository locally

Using Composer

composer create-project aagjalpankaj/laravel-package-template:dev-main your-package-name
cd your-package-name

⚡ Quick Start

After creating your package from this template, follow these steps:

1. Customize Package Information

Replace the following placeholders throughout your codebase:

2. Update Package Configuration

Edit the following files with your package details:

• composer.json - Package metadata, dependencies, and autoloading
• config/laravel-package-template.php - Package configuration file
• src/LaravelPackageTemplateServiceProvider.php - Service provider

Available Commands

Continuous Integration

GitHub Actions automatically run:

• ✅ Tests across multiple PHP versions
• ✅ Code style checks
• ✅ Static analysis
• ✅ Dependency security scanning