README

Laravel Specify

A small Laravel package to provide an interface for specifications and supporting documentation generated by githubs spec-kit

Status:: Stable

Contents

• Overview: What the package does and why to use it
• Installation: Composer install and asset/config publishing
• Configuration: config/specify.php explanation
• Usage: Routes, view composers and example blade snippets
• Testing: Running the package test suite
• Contributing & License

Overview

This package provides routes (default /specify) that lists the various outputs from githubs spec kit, and shows the contents of those files (/specify/{feature}/{file}) with as close to zero configuration as possible.

Installation

1. Require the package via Composer:

composer require blimeydev/laravel-specify

1. If your application does not use package auto-discovery, register the service provider in config/app.php:

   - Add \BlimeyDev\LaravelSpecify\SpecifyPagesServiceProvider::class to the providers array.

2. Publish the configuration, views, and assets (if applicable):

php artisan vendor:publish --provider="BlimeyDev\LaravelSpecify\SpecifyPagesServiceProvider" --tag="specify-config"
php artisan vendor:publish --provider="BlimeyDev\LaravelSpecify\SpecifyPagesServiceProvider" --tag="specify-views"
php artisan vendor:publish --provider="BlimeyDev\LaravelSpecify\SpecifyPagesServiceProvider" --tag="specify-compiled-assets"

If you would like to publish the source files, you can do so via

php artisan vendor:publish --provider="BlimeyDev\LaravelSpecify\SpecifyPagesServiceProvider" --tag="specify-assets"

Configuration

After publishing, edit config/specify.php to configure the package behavior (routes, middleware, or page settings).

Testing

Run the package test suite using Pest or PHPUnit from the package root:

composer install
./vendor/bin/testbench workbench:install
./vendor/bin/pest

License

This package is open source and available under the MIT License. See the LICENSE file for details.