Skip to content

Commit 1681c99

Browse files
committed
init package
1 parent efb76b0 commit 1681c99

22 files changed

+91
-392
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Ask a question
4-
url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
4+
url: https://github.com/KimSpeer/sortlist/discussions/new?category=q-a
55
about: Ask the community for help
66
- name: Request a feature
7-
url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
7+
url: https://github.com/KimSpeer/sortlist/discussions/new?category=ideas
88
about: Share ideas for new features
99
- name: Report a security issue
10-
url: https://github.com/:vendor_name/:package_name/security/policy
10+
url: https://github.com/KimSpeer/sortlist/security/policy
1111
about: Learn how to notify us for sensitive bugs
1212
- name: Report a bug
13-
url: https://github.com/:vendor_name/:package_name/issues/new
13+
url: https://github.com/KimSpeer/sortlist/issues/new
1414
about: Report a reproducable bug

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Changelog
22

3-
All notable changes to `:package_name` will be documented in this file.
3+
All notable changes to `sortlist` will be documented in this file.

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) :vendor_name <[email protected]>
3+
Copyright (c) KimSpeer <[email protected]>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 13 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,32 @@
1-
# TallUI :package_description
1+
# TallUI Test Alf
22

3-
[![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)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/run-tests?label=tests)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
5-
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
6-
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/kimspeer/sortlist.svg?style=flat-square)](https://packagist.org/packages/kimspeer/sortlist)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/kimspeer/sortlist/run-tests?label=tests)](https://github.com/kimspeer/sortlist/actions?query=workflow%3Arun-tests+branch%3Amain)
5+
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/kimspeer/sortlist/Check%20&%20fix%20styling?label=code%20style)](https://github.com/kimspeer/sortlist/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
6+
[![Total Downloads](https://img.shields.io/packagist/dt/kimspeer/sortlist.svg?style=flat-square)](https://packagist.org/packages/kimspeer/sortlist)
77

8-
<!--delete-->
9-
---
10-
This repo can be used to scaffold a TallUI package. Follow these steps to get started:
118

12-
1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
13-
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
14-
3. Have fun developing your package.
15-
16-
This package is based on [Laravel Package Tools by Spatie](https://github.com/spatie/laravel-package-tools), learn more about the simplified scaffolding of your service-provider there.
17-
18-
If you need help creating a package, consider picking up the <a href="https://laravelpackage.training">Laravel Package Training by Spatie</a> video course.
19-
20-
For most of the questions in configure.php, there will be an example migration, command, module, widget, block and component configured. You can directly start to build your package editing these examples. If you need more than one migration, command, module, widget, block or component, you can add these as an array. Don't forget to switch between
21-
22-
- ```hasMigration``` and ```hasMigrations```, or call ```hasMigration``` multiple times
23-
- ```hasCommand``` and ```hasCommands```, or call ```hasCommand``` multiple times
24-
- ```hasModule``` and ```hasModules```, or call ```hasModule``` multiple times
25-
- ```hasWidget``` and ```hasWidgets```, or call ```hasWidget``` multiple times
26-
- ```hasBlock``` and ```hasBlocks```, or call ```hasBlock``` multiple times
27-
28-
We stick to the conventions made in [Spatie's Laravel Package Tools](https://github.com/spatie/laravel-package-tools). If you are unsure about the syntax, read there.
29-
30-
## Todo:
31-
32-
Think about how to add each of these questions, or make them default.
33-
34-
### Questions in configure.php
35-
36-
- Does the package include config? Y/n
37-
- Does the package include views? Y/n
38-
- Does the package include translations? Y/n
39-
- Does the package include migrations? Y/n
40-
- Does the package include commands? Y/n
41-
- Does the package include admin modules? Y/n
42-
- Does the package include admin widgets? Y/n
43-
- Does the package include editor blocks? Y/n
44-
- Does the package include an admin theme? Y/n
45-
- Does the package include a website theme? Y/n
46-
- Does the package include docs? Y/n
47-
- Does the package include blade components? Y/n
48-
- Does the package include livewire components? Y/n
49-
50-
### Service Provider
51-
52-
- Add the package-provider in core or packages, extend spatie and use the own package provider
53-
- Add a demo blade and livewire-component
54-
- Add languages? Which ones?
55-
- Scaffold! :-)
56-
57-
### Config
58-
59-
- Idea: use config from blade-ui-kit instead of service provider
60-
- Design: add theming
61-
62-
### Docs
63-
64-
Probably a good idea to:
65-
66-
- How to create ... modules, ...
67-
68-
---
69-
<!--/delete-->
709
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
7110

7211
## Installation
7312

7413
You can install the package via composer:
7514

7615
```bash
77-
composer require :vendor_slug/:package_slug
16+
composer require kimspeer/sortlist
7817
```
7918

8019
You can publish and run the migrations with:
8120

8221
```bash
83-
php artisan vendor:publish --tag=":package_slug-migrations"
22+
php artisan vendor:publish --tag="sortlist-migrations"
8423
php artisan migrate
8524
```
8625

8726
You can publish the config file with:
8827

8928
```bash
90-
php artisan vendor:publish --tag=":package_slug-config"
29+
php artisan vendor:publish --tag="sortlist-config"
9130
```
9231

9332
This is the contents of the published config file:
@@ -100,14 +39,14 @@ return [
10039
Optionally, you can publish the views using
10140

10241
```bash
103-
php artisan vendor:publish --tag=":package_slug-views"
42+
php artisan vendor:publish --tag="sortlist-views"
10443
```
10544

10645
## Usage
10746

10847
```php
109-
$variable = new VendorName\Skeleton();
110-
echo $variable->echoPhrase('Hello, VendorName!');
48+
$sort = new KimSpeer\Sort();
49+
echo $sort->echoPhrase('Hello, KimSpeer!');
11150
```
11251

11352
## Testing
@@ -130,9 +69,9 @@ Please review [our security policy](../../security/policy) on how to report secu
13069

13170
## Credits
13271

133-
This package is based on Package Skeleton Laravel from [Spatie](https://spatie.be/products). If you are a Laravel developer, their services, products and trainings are for you. Otherwise they love post cards.
72+
This package is based on Package Sort Laravel from [Spatie](https://spatie.be/products). If you are a Laravel developer, their services, products and trainings are for you. Otherwise they love post cards.
13473

135-
- [:author_name](https://github.com/:author_username)
74+
- [KimSpeer](https://github.com/KimSpeer)
13675
- [TALLUI Devs](https://github.com/orgs/usetall/people)
13776
- [Freek Van der Herten](https://github.com/freekmurze)
13877
- [All Contributors](../../contributors)

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Supported Versions
44

5-
We maintain the current version of `:package_name` actively.
5+
We maintain the current version of `sortlist` actively.
66

77
Do not expect security fixes for older versions.
88

99
## Reporting a Vulnerability
1010

11-
If you find any security-related bug, please report it to [email protected].
11+
If you find any security-related bug, please report it to [email protected].
1212

1313
Please do not use Github issues, to give us enough time to review and fix the issue, before others can use it, to do stupid things.

composer.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
{
2-
"name": ":vendor_slug/:package_slug",
3-
"description": ":package_description",
2+
"name": "kimspeer/sortlist",
3+
"description": "Test Alf",
44
"keywords": [
5-
":vendor_name",
5+
"KimSpeer",
66
"laravel",
7-
":package_slug",
7+
"sortlist",
88
"tall-stack",
99
"tailwindcss",
1010
"alpinejs",
1111
"livewire",
1212
"admin"
1313
],
14-
"homepage": "https://github.com/:vendor_slug/:package_slug",
14+
"homepage": "https://github.com/kimspeer/sortlist",
1515
"license": "MIT",
1616
"authors": [
1717
{
18-
"name": ":author_name",
19-
"email": "[email protected]",
18+
"name": "KimSpeer",
19+
"email": "[email protected]",
2020
"role": "Developer"
2121
}
2222
],
@@ -39,13 +39,13 @@
3939
},
4040
"autoload": {
4141
"psr-4": {
42-
"VendorName\\Skeleton\\": "src",
43-
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
42+
"KimSpeer\\Sort\\": "src",
43+
"KimSpeer\\Sort\\Database\\Factories\\": "database/factories"
4444
}
4545
},
4646
"autoload-dev": {
4747
"psr-4": {
48-
"VendorName\\Skeleton\\Tests\\": "tests"
48+
"KimSpeer\\Sort\\Tests\\": "tests"
4949
}
5050
},
5151
"scripts": {
@@ -59,10 +59,10 @@
5959
"extra": {
6060
"laravel": {
6161
"providers": [
62-
"VendorName\\Skeleton\\SkeletonServiceProvider"
62+
"KimSpeer\\Sort\\SortServiceProvider"
6363
],
6464
"aliases": {
65-
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
65+
"Sort": "KimSpeer\\Sort\\Facades\\Sort"
6666
}
6767
}
6868
},

config/skeleton.php renamed to config/sortlist.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?php
2-
use VendorName\Skeleton\Components;
2+
use KimSpeer\Sort\Components;
33

44
return [
55

@@ -9,7 +9,7 @@
99
|--------------------------------------------------------------------------
1010
|
1111
| Below you reference all components that should be loaded for your app.
12-
| By default all components from :package_name are loaded in. You can
12+
| By default all components from sortlist are loaded in. You can
1313
| disable or overwrite any component class or alias that you want.
1414
|
1515
*/
@@ -24,7 +24,7 @@
2424
|--------------------------------------------------------------------------
2525
|
2626
| Below you reference all the Livewire components that should be loaded
27-
| for your app. By default all components from :package_name are loaded in.
27+
| for your app. By default all components from sortlist are loaded in.
2828
|
2929
*/
3030

@@ -37,7 +37,7 @@
3737
| Components Prefix
3838
|--------------------------------------------------------------------------
3939
|
40-
| This value will set a prefix for all :package_name components.
40+
| This value will set a prefix for all sortlist components.
4141
| By default it's empty. This is useful if you want to avoid
4242
| collision with or otherwise overwrite core components.
4343
|

0 commit comments

Comments
 (0)