Initial release of package (#1)

* configure package

* Initial setup to find icons and cache results

* Ignore cache directory

* Change workflows

* Update workflow to install npm dependencies

* Test workflow

* Icons being found, cached, and tests passing

* Pint format code

* Clean up and get tests fixed

* Blade directive to publish out config

* Fix styling

* Collection routes

* Refactor to increase test coverage

* Clean up and fix domain

* Install command and cache refactor

* Refactor to cache icon info separate from the icon data to lower repeated caches

* Format code

* Clean up

* Tests passing

* Unset data right away

* Test expanding testing matrix

* Only do version 11 and 12

* Update dependencies

* Revert to only testing Laravel 11

* Remove declaring carbon version

* Okay okay, bring back carbon version

* Update dependencies

* Clean up and correct types

* Documentation and ability to turn off API

* Add contributing docs

* Update README.md

* Clean up email

---------

Co-authored-by: abetwothree <[email protected]>

Author: abetwothree

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: Abraham Arango

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: Ask a question
-    url: https://github.com/:vendor_slug/:package_name/discussions/new?category=q-a
+    url: https://github.com/abetwothree/laravel-iconify-api/discussions/new?category=q-a
     about: Ask the community for help
   - name: Request a feature
-    url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas
+    url: https://github.com/abetwothree/laravel-iconify-api/discussions/new?category=ideas
     about: Share ideas for new features
   - name: Report a security issue
-    url: https://github.com/:vendor_slug/:package_name/security/policy
+    url: https://github.com/abetwothree/laravel-iconify-api/security/policy
     about: Learn how to notify us for sensitive bugs

.github/workflows/run-tests.yml

@@ -17,16 +17,13 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        php: [8.4, 8.3]
-        laravel: [11.*, 10.*]
+        php: [8.4]
+        laravel: [11.*]
         stability: [prefer-lowest, prefer-stable]
         include:
           - laravel: 11.*
             testbench: 9.*
             carbon: ^2.63
-          - laravel: 10.*
-            testbench: 8.*
-            carbon: ^2.63
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
@@ -54,5 +51,9 @@ jobs:
       - name: List Installed Dependencies
         run: composer show -D
 
+      - name: Install workflow npm dependencies
+        run: |
+          npm ci
+
       - name: Execute tests
         run: vendor/bin/pest --ci

.gitignore

@@ -4,6 +4,7 @@ composer.lock
 
 # Frontend Assets
 /node_modules
+/workbench/node_modules
 
 # Logs
 npm-debug.log
@@ -13,6 +14,7 @@ yarn-error.log
 .phpunit.cache
 .phpunit.result.cache
 /build
+.DS_Store
 
 # IDE Helper
 _ide_helper.php
@@ -30,3 +32,4 @@ phpstan.neon
 testbench.yaml
 /docs
 /coverage
+coverage.xml

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `laravel-iconify-api` will be documented in this file.

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+Contributions are welcomed in the for of a Pull Request. 
+
+In order for your contributions to be considered, please make sure the following steps are taken:
+
+* Pipeline checks must pass
+* Code quality must not be degraded
+* Features must not be broken or removed
+* New features must be tested
+* Documentation must be updated where necessary

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <[email protected]>
+Copyright (c) Abraham Arango
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,75 +1,51 @@
-# :package_description
+# Laravel Iconify API
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-<!--delete-->
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/abetwothree/laravel-iconify-api.svg?style=flat-square)](https://packagist.org/packages/abetwothree/laravel-iconify-api)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/abetwothree/laravel-iconify-api/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/abetwothree/laravel-iconify-api/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/abetwothree/laravel-iconify-api/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/abetwothree/laravel-iconify-api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/abetwothree/laravel-iconify-api.svg?style=flat-square)](https://packagist.org/packages/abetwothree/laravel-iconify-api)
 
-1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
-3. Have fun creating your package.
-4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-<!--/delete-->
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+This is a Laravel package for the [Iconify](https://iconify.design/index.html) icons [on demand API](https://iconify.design/docs/icon-components/). It allows you to easily use on demand icons and use your Laravel applicatioin as the Iconify API.
 
-## Support us
+It works similarly to the [Node Iconify API](https://github.com/iconify/api) and is a spiritual successor to their [PHP implementation](https://github.com/iconify/api.php).
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
+On demand icons work great whether you use Livewire, Inertia, or just plain Blade views to render your Laravel application and want to render icons dynamically using a single component.
 
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
+## How To Use
 
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
-
-## Installation
-
-You can install the package via composer:
+Install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require abetwothree/laravel-iconify-api
 ```
 
-You can publish and run the migrations with:
+In your core application blade layout file add the following directive in the head section before your application's JS bundle:
 
-```bash
-php artisan vendor:publish --tag=":package_slug-migrations"
-php artisan migrate
+```html
+@iconify
 ```
 
-You can publish the config file with:
+This will configure the [Iconify API](https://iconify.design/docs/api/providers.html#api-config) on demand icons to load the icons from your Laravel application instead of the Iconify API.
 
-```bash
-php artisan vendor:publish --tag=":package_slug-config"
-```
+### How To Display Icons
 
-This is the contents of the published config file:
+To displays icons follow the instructions on the [Iconify](https://iconify.design/docs/icon-components/) on demand docs and use any of their component libraries in your Laravel Application.
 
-```php
-return [
-];
-```
+You also need icon set data to be available in your application. You'll need to install the icon set data using NPM. See more [info here](https://iconify.design/docs/icons/icon-data.html#sources).
 
-Optionally, you can publish the views using
+We recommend installing individual icon sets instead of the entire Iconify JSON set to keep your application lightweight. However, you can install the entire set if you wish and this package will work with either approach.
 
-```bash
-php artisan vendor:publish --tag=":package_slug-views"
-```
+## Advanced Configuration
 
-## Usage
+To configure the package, you can publish the config file using the following command:
 
-```php
-$variable = new VendorName\Skeleton();
-echo $variable->echoPhrase('Hello, VendorName!');
+```bash
+php artisan vendor:publish --tag="iconify-api-config"
 ```
 
-## Testing
+This will publish a `iconify-api.php` file in your `config` directory. You can then configure the package to your liking.
 
-```bash
-composer test
-```
+For advanced setting details, please see the [config file](config/iconify-api.php).
 
 ## Changelog
 
@@ -85,7 +61,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Abraham Arango](https://github.com/abetwothree)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -1,57 +1,75 @@
 {
-    "name": ":vendor_slug/:package_slug",
-    "description": ":package_description",
+    "name": "abetwothree/laravel-iconify-api",
+    "description": "A package to create a local API for the dynamic Iconify Icon components",
     "keywords": [
-        ":vendor_name",
+        "Abraham Arango",
         "laravel",
-        ":package_slug"
+        "laravel-iconify-api"
     ],
-    "homepage": "https://github.com/:vendor_slug/:package_slug",
+    "homepage": "https://github.com/abetwothree/laravel-iconify-api",
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": "[email protected]",
+            "name": "Abraham Arango",
             "role": "Developer"
         }
     ],
     "require": {
         "php": "^8.4",
         "spatie/laravel-package-tools": "^1.16",
-        "illuminate/contracts": "^10.0||^11.0"
+        "illuminate/contracts": "^11.0"
     },
     "require-dev": {
+        "larastan/larastan": "^3.0",
         "laravel/pint": "^1.14",
         "nunomaduro/collision": "^8.1.1||^7.10.0",
-        "larastan/larastan": "^2.9",
         "orchestra/testbench": "^9.0.0||^8.22.0",
         "pestphp/pest": "^3.0",
         "pestphp/pest-plugin-arch": "^3.0",
         "pestphp/pest-plugin-laravel": "^3.0",
-        "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan-deprecation-rules": "^1.1",
-        "phpstan/phpstan-phpunit": "^1.3",
-        "spatie/laravel-ray": "^1.35"
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0"
     },
     "autoload": {
         "psr-4": {
-            "VendorName\\Skeleton\\": "src/",
-            "VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
+            "AbeTwoThree\\LaravelIconifyApi\\": "src/",
+            "AbeTwoThree\\LaravelIconifyApi\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "VendorName\\Skeleton\\Tests\\": "tests/",
-            "Workbench\\App\\": "workbench/app/"
+            "AbeTwoThree\\LaravelIconifyApi\\Tests\\": "tests/",
+            "Workbench\\App\\": "workbench/app/",
+            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
         }
     },
     "scripts": {
-        "post-autoload-dump": "@composer run prepare",
+        "post-autoload-dump": [
+            "@prepare",
+            "@composer run prepare"
+        ],
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "analyse": "vendor/bin/phpstan analyse",
         "test": "vendor/bin/pest",
-        "test-coverage": "vendor/bin/pest --coverage",
-        "format": "vendor/bin/pint"
+        "testbench": "vendor/bin/testbench",
+        "test-coverage": "export XDEBUG_MODE=coverage && vendor/bin/pest --coverage",
+        "test-coverage-html": "export XDEBUG_MODE=coverage && vendor/bin/pest --coverage-html coverage",
+        "test-coverage-xml": "export XDEBUG_MODE=coverage && vendor/bin/pest --coverage-xml coverage",
+        "test-coverage-cov": "export XDEBUG_MODE=coverage && vendor/bin/pest --coverage-clover coverage.xml",
+        "format": "vendor/bin/pint",
+        "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+        "build": "@php vendor/bin/testbench workbench:build --ansi",
+        "serve": [
+            "Composer\\Config::disableProcessTimeout",
+            "@build",
+            "@php vendor/bin/testbench serve --ansi"
+        ],
+        "lint": [
+            "@php vendor/bin/pint --ansi",
+            "@php vendor/bin/phpstan analyse --verbose --ansi"
+        ]
     },
     "config": {
         "sort-packages": true,
@@ -63,10 +81,10 @@
     "extra": {
         "laravel": {
             "providers": [
-                "VendorName\\Skeleton\\SkeletonServiceProvider"
+                "AbeTwoThree\\LaravelIconifyApi\\LaravelIconifyApiServiceProvider"
             ],
             "aliases": {
-                "Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
+                "LaravelIconifyApi": "AbeTwoThree\\LaravelIconifyApi\\Facades\\LaravelIconifyApi"
             }
         }
     },