Skip to content

Commit

Permalink
configure package
Browse files Browse the repository at this point in the history
  • Loading branch information
freekmurze committed Nov 15, 2021
1 parent a4ade47 commit 5b552b3
Show file tree
Hide file tree
Showing 21 changed files with 79 additions and 230 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: :vendor_name
github: spatie
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
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/spatie/laravel-health/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/spatie/laravel-health/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/spatie/laravel-health/security/policy
about: Learn how to notify us for sensitive bugs
- name: Report a bug
url: https://github
- name: Report a bug
url: https://github.com/:vendor_name/:package_name/issues/new
url: https://github.com/spatie/laravel-health/issues/new
about: Report a reproducable bug
2 changes: 1 addition & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Security Policy

If you discover any security related issues, please email [email protected] instead of using the issue tracker.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to `laravel-health` will be documented in this file.

## 1.0.0 - 202X-XX-XX

Expand Down
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 <[email protected]>
Copyright (c) spatie <[email protected]>

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
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# :package_description
# Check the health of your Laravel app

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

---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:

1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this laravel-health
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
3. Remove this block of text.
4. Have fun creating your package.
Expand All @@ -19,7 +19,7 @@ This is where your description should go. Limit it to a paragraph or two. Consid

## Support us

[<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)
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-health.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-health)

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

Expand All @@ -30,19 +30,19 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
You can install the package via composer:

```bash
composer require :vendor_slug/:package_slug
composer require spatie/laravel-health
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag=":package_slug_without_prefix-migrations"
php artisan vendor:publish --tag="laravel-health_without_prefix-migrations"
php artisan migrate
```

You can publish the config file with:
```bash
php artisan vendor:publish --tag=":package_slug_without_prefix-config"
php artisan vendor:publish --tag="laravel-health_without_prefix-config"
```

Optionally, you can publish the views using
Expand All @@ -61,8 +61,8 @@ return [
## Usage

```php
$skeleton = new VendorName\Skeleton();
echo $skeleton->echoPhrase('Hello, VendorName!');
$laravel-health = new Spatie\Health();
echo $laravel-health->echoPhrase('Hello, Spatie!');
```

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

## Credits

- [:author_name](https://github.com/:author_username)
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)

## License
Expand Down
24 changes: 12 additions & 12 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": "spatie/laravel-health",
"description": "Check the health of your Laravel app",
"keywords": [
":vendor_name",
"spatie",
"laravel",
":package_slug"
"laravel-health"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/spatie/laravel-health",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "[email protected]",
"name": "Freek Van der Herten",
"email": "[email protected]",
"role": "Developer"
}
],
Expand All @@ -34,13 +34,13 @@
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
"Spatie\\Health\\": "src",
"Spatie\\Health\\Database\\Factories\\": "database/factories"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests"
"Spatie\\Health\\Tests\\": "tests"
}
},
"scripts": {
Expand All @@ -54,10 +54,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Spatie\\Health\\HealthServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\SkeletonFacade"
"Health": "Spatie\\Health\\HealthFacade"
}
}
},
Expand Down
5 changes: 5 additions & 0 deletions config/health.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?php
// config for Spatie/Health
return [

];
5 changes: 0 additions & 5 deletions config/skeleton.php

This file was deleted.

151 changes: 0 additions & 151 deletions configure.php

This file was deleted.

2 changes: 1 addition & 1 deletion database/factories/ModelFactory.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace VendorName\Skeleton\Database\Factories;
namespace Spatie\Health\Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ return new class extends Migration
{
public function up()
{
Schema::create('skeleton_table', function (Blueprint $table) {
Schema::create('laravel-health_table', function (Blueprint $table) {
$table->id();

// add fields
Expand Down
2 changes: 1 addition & 1 deletion phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
verbose="true"
>
<testsuites>
<testsuite name="VendorName Test Suite">
<testsuite name="Spatie Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?php

namespace VendorName\Skeleton\Commands;
namespace Spatie\Health\Commands;

use Illuminate\Console\Command;

class SkeletonCommand extends Command
class HealthCommand extends Command
{
public $signature = 'skeleton';
public $signature = 'laravel-health';

public $description = 'My command';

Expand Down
7 changes: 7 additions & 0 deletions src/Health.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Spatie\Health;

class Health
{
}
Loading

0 comments on commit 5b552b3

Please sign in to comment.