Skip to content

Commit

Permalink
V1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
colinhall17 committed Aug 18, 2022
1 parent 4abbad5 commit dea97b3
Show file tree
Hide file tree
Showing 104 changed files with 297 additions and 685 deletions.
3 changes: 0 additions & 3 deletions .github/FUNDING.yml

This file was deleted.

36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/workflows/psalm.yml

This file was deleted.

12 changes: 4 additions & 8 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,12 @@ jobs:
fail-fast: true
matrix:
os: [ubuntu-latest, windows-latest]
php: [7.3, 7.4]
laravel: [6.*, 7.*, 8.*]
php: [8.0, 8.1]
laravel: [9.*]
dependency-version: [prefer-lowest, prefer-stable]
include:
- laravel: 8.*
testbench: 6.*
- laravel: 7.*
testbench: 5.*
- laravel: 6.*
testbench: 4.*
- laravel: 9.*
testbench: 7.*

name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}

Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Changelog

All notable changes to `:package_name` will be documented in this file
All notable changes to `blade-heroicons` will be documented in this file

## 1.0.0 - 202X-XX-XX
## 1.0.0 - 2022-08-18

- initial release
49 changes: 0 additions & 49 deletions CONTRIBUTING.md

This file was deleted.

10 changes: 0 additions & 10 deletions LICENSE.md

This file was deleted.

61 changes: 8 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,37 @@
# :package_name
# Blade Heroicons

## Sub Heading
## Heroicons as Blade Components

![Header Image](https://github.com/MacsiDigital/repo-design/raw/master/:package_name/header.png)

<p align="center">
<a href="https://github.com/MacsiDigital/:package_name/actions?query=workflow%3ATests"><img src="https://github.com/MacsiDigital/:package_name/workflows/Tests/badge.svg" style="max-width:100%;" alt="tests badge"></a>
<a href="https://packagist.org/packages/macsidigital/:package_name"><img src="https://img.shields.io/packagist/v/macsidigital/:package_name.svg?style=flat-square" alt="version badge"/></a>
<a href="https://packagist.org/packages/macsidigital/:package_name"><img src="https://img.shields.io/packagist/dt/macsidigital/:package_name.svg?style=flat-square" alt="downloads badge"/></a>
</p>


**Note:** Replace ```:author_name``` ```:author_username``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line. You can also run `configure-skeleton.sh` to do this automatically.

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Support us

We invest a lot in creating [open source packages](https://macsidigital.co.uk/open-source), and would be grateful for a [sponsor](https://github.com/sponsors/MacsiDigital) if you make money from your product that uses them.
Heroicons as Blade Componenents

## Installation

You can install the package via composer:

```bash
composer require macsidigital/package-skeleton-laravel
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --provider="MacsiDigital\Skeleton\Providers\SkeletonServiceProvider" --tag="migrations"
php artisan migrate
composer require macsidigital/blade-heroicons
```

You can publish the config file with:

```bash
php artisan vendor:publish --provider="MacsiDigital\Skeleton\Providers\SkeletonServiceProvider" --tag="config"
php artisan vendor:publish --provider="MacsiDigital\BladeHeroicons\BladeHeroiconsServiceProvider" --tag="config"
```

This is the contents of the published config file:

```php
return [

];
```

## Usage

``` php
$skeleton = new MacsiDigital\Skeleton();
echo $skeleton->echoPhrase('Hello, MacsiDigital!');
```

## Testing

``` bash
composer test
<x-heroicons:solid.academy-cap class="h-4 w-4" />
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security-related issues, please email [[email protected]](mailto:[email protected]) instead of using the issue tracker.

## Credits

- [:author_name](https://github.com/:author_username)
- [MacsiDigital](https://github.com/MacsiDigital)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
31 changes: 14 additions & 17 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,42 +1,39 @@
{
"name": "macsidigital/:package_name",
"description": ":package_description",
"name": "macsidigital/blade-heroicons",
"description": "Blade Heroicons",
"keywords": [
"macsidigital",
":package_name"
"blade-heroicons"
],
"homepage": "https://github.com/macsidigital/:package_name",
"homepage": "https://github.com/macsidigital/blade-heroicons",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": ":author_email",
"name": "Colin Hall",
"email": "[email protected]",
"homepage": "https://macsidigital.co.uk",
"role": "Developer"
}
],
"require": {
"php": "^7.3"
"php": "^8.0"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^2.16",
"orchestra/testbench": "^5.0",
"phpunit/phpunit": "^9.0",
"psalm/plugin-laravel": "^1.4",
"vimeo/psalm": "^3.11"
"friendsofphp/php-cs-fixer": "^3.0",
"orchestra/testbench": "^7.0",
"phpunit/phpunit": "^9.5"
},
"autoload": {
"psr-4": {
"MacsiDigital\\Skeleton\\": "src"
"MacsiDigital\\BladeHeroicons\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"MacsiDigital\\Skeleton\\Tests\\": "tests"
"MacsiDigital\\BladeHeroicons\\Tests\\": "tests"
}
},
"scripts": {
"psalm": "vendor/bin/psalm",
"test": "vendor/bin/phpunit",
"test-coverage": "vendor/bin/phpunit --coverage-html coverage",
"format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
Expand All @@ -47,10 +44,10 @@
"extra": {
"laravel": {
"providers": [
"MacsiDigital\\Skeleton\\Providers\\SkeletonServiceProvider"
"MacsiDigital\\BladeHeroicons\\BladeHeroiconsServiceProvider"
],
"aliases": {
"Skeleton": "MacsiDigital\\Skeleton\\Facades\\Package"
"BladeHeroicons": "MacsiDigital\\BladeHeroicons\\Facades\\Package"
}
}
},
Expand Down
7 changes: 1 addition & 6 deletions config/config.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
<?php

return [
'routes' => [
'web_prefix' => 'skeleton',
'web_middleware' => ['web'],
'api_prefix' => 'skeleton/api',
'web_middleware' => ['api'],
]
'prefix' => 'heroicons'
];
2 changes: 1 addition & 1 deletion configure-skeleton.sh
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ echo
find . -type f -exec sed -i '' -e "s/:author_name/$author_name/g" {} \;
find . -type f -exec sed -i '' -e "s/:author_username/$author_username/g" {} \;
find . -type f -exec sed -i '' -e "s/:author_email/$author_email/g" {} \;
find . -type f -exec sed -i '' -e "s/:package_name/$package_name/g" {} \;
find . -type f -exec sed -i '' -e "s/blade-heroicons/$package_name/g" {} \;
find . -type f -exec sed -i '' -e "s/:package_description/$package_description/g" {} \;

sed -i '' -e "/^\*\*Note:\*\* Replace/d" README.md
Expand Down
43 changes: 0 additions & 43 deletions database/factories/SkeletonFactory.php

This file was deleted.

Loading

0 comments on commit dea97b3

Please sign in to comment.