Skip to content

Commit

Permalink
feat: configure project
Browse files Browse the repository at this point in the history
  • Loading branch information
ast21 committed Jul 6, 2023
1 parent c0e547d commit b892751
Show file tree
Hide file tree
Showing 31 changed files with 86 additions and 690 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/:github_name/:package_name/discussions/new?category=q-a
url: https://github.com/ibec-box/admin-kit-seo/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/:github_name/:package_name/discussions/new?category=ideas
url: https://github.com/ibec-box/admin-kit-seo/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/:github_name/:package_name/security/policy
url: https://github.com/ibec-box/admin-kit-seo/security/policy
about: Learn how to notify us for sensitive bugs
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `admin-kit-seo` will be documented in this file.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) :github_name <author@domain.com>
Copyright (c) ibec-box <ast@l80.ru>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,31 @@
# :package_description

[![Latest Version on Packagist](https://img.shields.io/packagist/v/:github_name/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:packagist_name/:package_slug)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:github_name/:package_slug/run-tests.yml?branch=2.x&label=tests&style=flat-square)](https://github.com/:github_name/:package_slug/actions?query=workflow%3Arun-tests+branch%3A2.x)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:github_name/:package_slug/fix-php-code-style-issues.yml?branch=2.x&label=code%20style&style=flat-square)](https://github.com/:github_name/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3A2.x)
[![Total Downloads](https://img.shields.io/packagist/dt/:github_name/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:packagist_name/:package_slug)
<!--delete-->
---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:

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-->
# SEO package for Admin Kit

[![Latest Version on Packagist](https://img.shields.io/packagist/v/ibec-box/admin-kit-seo.svg?style=flat-square)](https://packagist.org/packages/ibecsystems/admin-kit-seo)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ibec-box/admin-kit-seo/run-tests.yml?branch=2.x&label=tests&style=flat-square)](https://github.com/ibec-box/admin-kit-seo/actions?query=workflow%3Arun-tests+branch%3A2.x)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ibec-box/admin-kit-seo/fix-php-code-style-issues.yml?branch=2.x&label=code%20style&style=flat-square)](https://github.com/ibec-box/admin-kit-seo/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3A2.x)
[![Total Downloads](https://img.shields.io/packagist/dt/ibec-box/admin-kit-seo.svg?style=flat-square)](https://packagist.org/packages/ibecsystems/admin-kit-seo)

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

## Installation

You can install the package via composer:

```bash
composer require :packagist_name/:package_slug
composer require ibecsystems/admin-kit-seo
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan vendor:publish --tag="admin-kit-seo-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag=":package_slug-config"
php artisan vendor:publish --tag="admin-kit-seo-config"
```

This is the contents of the published config file:
Expand All @@ -47,14 +38,14 @@ return [
Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag=":package_slug-views"
php artisan vendor:publish --tag="admin-kit-seo-views"
```

## Usage

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
$sEO = new AdminKit\SEO();
echo $sEO->echoPhrase('Hello, AdminKit!');
```

## Testing
Expand All @@ -77,7 +68,7 @@ Please review [our security policy](../../security/policy) on how to report secu

## Credits

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

## License
Expand Down
26 changes: 11 additions & 15 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": ":packagist_name/:package_slug",
"description": ":package_description",
"name": "ibecsystems/admin-kit-seo",
"description": "SEO package for Admin Kit",
"keywords": [
":github_name",
"ibec-box",
"laravel",
":package_slug"
"admin-kit-seo"
],
"homepage": "https://github.com/:github_name/:package_slug",
"homepage": "https://github.com/ibec-box/admin-kit-seo",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Anastas Mironov",
"email": "ast@l80.ru",
"role": "Developer"
}
],
Expand Down Expand Up @@ -41,13 +41,12 @@
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"AdminKit\\SEO\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/"
"AdminKit\\SEO\\Tests\\": "tests/"
}
},
"scripts": {
Expand All @@ -67,11 +66,8 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
}
"AdminKit\\SEO\\SEOServiceProvider"
]
}
},
"minimum-stability": "dev",
Expand Down
6 changes: 6 additions & 0 deletions config/admin-kit-seo.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?php

// config for AdminKit/SEO
return [
//
];
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

0 comments on commit b892751

Please sign in to comment.