Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
sitesurfer committed Oct 11, 2023
1 parent 1043211 commit 42c47b1
Show file tree
Hide file tree
Showing 25 changed files with 83 additions and 475 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/:vendor_name/:package_name/discussions/new?category=q-a
url: https://github.com/sitesurfer/tc_osdata/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
url: https://github.com/sitesurfer/tc_osdata/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/:vendor_name/:package_name/security/policy
url: https://github.com/sitesurfer/tc_osdata/security/policy
about: Learn how to notify us for sensitive bugs
12 changes: 0 additions & 12 deletions .github/dependabot.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/dependabot-auto-merge.yml

This file was deleted.

27 changes: 0 additions & 27 deletions .github/workflows/fix-php-code-style-issues.yml

This file was deleted.

26 changes: 0 additions & 26 deletions .github/workflows/phpstan.yml

This file was deleted.

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 `tc_osdata` 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) :vendor_name <author@domain.com>
Copyright (c) sitesurfer <owenlees@mac.com>

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
45 changes: 17 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,37 @@
# :package_description
# This is my package tc-osdata

[![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/sitesurfer/tc-osdata.svg?style=flat-square)](https://packagist.org/packages/sitesurfer/tc-osdata)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/sitesurfer/tc-osdata/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/sitesurfer/tc-osdata/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/sitesurfer/tc-osdata/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/sitesurfer/tc-osdata/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/sitesurfer/tc-osdata.svg?style=flat-square)](https://packagist.org/packages/sitesurfer/tc-osdata)

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 package simply wraps the OS API into a Laravel friendly package.
The facade is the easiest way to use the package.
For instance : TCOSDATA::postcode('1234AB') will return the data for that postcode.
(Dont forget to add the use statement at the top of your file : use Sitesurfer\tcosdata\Facades\TCOSDATA;)

## Support us
```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)

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).

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:

```bash
composer require :vendor_slug/:package_slug
composer require sitesurfer/tc-osdata
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan vendor:publish --tag="tc-osdata-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="tc-osdata-config"
```

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

```bash
php artisan vendor:publish --tag=":package_slug-views"
php artisan vendor:publish --tag="tc-osdata-views"
```

## Usage

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
$tCOsdata = new Sitesurfer\TCOsdata();
echo $tCOsdata->echoPhrase('Hello, Sitesurfer!');
```

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

## Credits

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

## License
Expand Down
32 changes: 14 additions & 18 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "sitesurfer/tc-osdata",
"description": "This is my package tc-osdata",
"keywords": [
":vendor_name",
"sitesurfer",
"laravel",
":package_slug"
"tc-osdata"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/sitesurfer/tc-osdata",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Owen Lees",
"email": "owenlees@mac.com",
"role": "Developer"
}
],
Expand All @@ -23,31 +23,27 @@
"require-dev": {
"laravel/pint": "^1.0",
"nunomaduro/collision": "^7.8",
"nunomaduro/larastan": "^2.0.1",
"orchestra/testbench": "^8.8",
"pestphp/pest": "^2.20",
"pestphp/pest-plugin-arch": "^2.0",
"pestphp/pest-plugin-laravel": "^2.0",
"phpstan/extension-installer": "^1.1",
"phpstan/phpstan-deprecation-rules": "^1.0",
"phpstan/phpstan-phpunit": "^1.0",
"spatie/laravel-ray": "^1.26"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"Sitesurfer\\TCOsdata\\": "src/",
"Sitesurfer\\TCOsdata\\Database\\Factories\\": "database/factories/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/",
"Sitesurfer\\TCOsdata\\Tests\\": "tests/",
"Workbench\\App\\": "workbench/app/"
}
},
"scripts": {
"post-autoload-dump": "@composer run prepare",
"clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
"clear": "@php vendor/bin/testbench package:purge-tc-osdata --ansi",
"prepare": "@php vendor/bin/testbench package:discover --ansi",
"build": [
"@composer run prepare",
Expand All @@ -73,13 +69,13 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Sitesurfer\\TCOsdata\\TCOsdataServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"TCOsdata": "Sitesurfer\\TCOsdata\\Facades\\TCOsdata"
}
}
},
"minimum-stability": "dev",
"prefer-stable": true
}
}
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

6 changes: 6 additions & 0 deletions config/tc-osdata.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?php

// config for Sitesurfer/TCOsdata
return [

];
Loading

0 comments on commit 42c47b1

Please sign in to comment.