generated from spatie/package-skeleton-laravel
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ead1450
commit 9f0e19f
Showing
22 changed files
with
138 additions
and
529 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| github: :vendor_name | ||
| github: Cleanique Coders |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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_slug/:package_name/discussions/new?category=q-a | ||
| url: https://github.com/cleaniquecoders/app-pulse/discussions/new?category=q-a | ||
| about: Ask the community for help | ||
| - name: Request a feature | ||
| url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas | ||
| url: https://github.com/cleaniquecoders/app-pulse/discussions/new?category=ideas | ||
| about: Share ideas for new features | ||
| - name: Report a security issue | ||
| url: https://github.com/:vendor_slug/:package_name/security/policy | ||
| url: https://github.com/cleaniquecoders/app-pulse/security/policy | ||
| about: Learn how to notify us for sensitive bugs |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 `app-pulse` will be documented in this file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,93 +1,121 @@ | ||
| # :package_description | ||
| [](https://packagist.org/packages/cleaniquecoders/app-pulse) [](https://github.com/cleaniquecoders/app-pulse/actions?query=workflow%3Arun-tests+branch%3Amain) [](https://github.com/cleaniquecoders/app-pulse/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) [](https://packagist.org/packages/cleaniquecoders/app-pulse) | ||
|
|
||
| [](https://packagist.org/packages/:vendor_slug/:package_slug) | ||
| [](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain) | ||
| [](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) | ||
| [](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: | ||
|
|
||
| 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. | ||
| # **AppPulse** | ||
|
|
||
| ## Support us | ||
| A comprehensive, easy-to-use monitoring tool with **uptime tracking, SSL certificate checks**, and **customizable notifications** designed for Laravel applications. | ||
|
|
||
| [<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) | ||
| **AppPulse** allows developers to monitor websites efficiently by: | ||
|
|
||
| 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). | ||
| - Tracking **website uptime** and logging response times. | ||
| - **Validating SSL certificates** and sending alerts when expiry is near. | ||
| - Providing **custom notifications** that adhere to user configurations, ensuring personalized alerts. | ||
|
|
||
| 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 | ||
| ## **Installation** | ||
|
|
||
| You can install the package via composer: | ||
| You can install the package via Composer: | ||
|
|
||
| ```bash | ||
| composer require :vendor_slug/:package_slug | ||
| composer require cleaniquecoders/app-pulse | ||
| ``` | ||
|
|
||
| You can publish and run the migrations with: | ||
| Publish and run the migrations: | ||
|
|
||
| ```bash | ||
| php artisan vendor:publish --tag=":package_slug-migrations" | ||
| php artisan vendor:publish --tag="app-pulse-migrations" | ||
| php artisan migrate | ||
| ``` | ||
|
|
||
| You can publish the config file with: | ||
| Publish the configuration file: | ||
|
|
||
| ```bash | ||
| php artisan vendor:publish --tag=":package_slug-config" | ||
| php artisan vendor:publish --tag="app-pulse-config" | ||
| ``` | ||
|
|
||
| This is the contents of the published config file: | ||
| Published config file contents: | ||
|
|
||
| ```php | ||
| return [ | ||
| 'default_check_interval' => 5, // Default interval in minutes | ||
| 'ssl_warning_days' => 30, // Days before SSL expiry to trigger alert | ||
| ]; | ||
| ``` | ||
|
|
||
| Optionally, you can publish the views using | ||
| Optionally, you can publish the views with: | ||
|
|
||
| ```bash | ||
| php artisan vendor:publish --tag=":package_slug-views" | ||
| php artisan vendor:publish --tag="app-pulse-views" | ||
| ``` | ||
|
|
||
| ## Usage | ||
| --- | ||
|
|
||
| ## **Usage Example** | ||
|
|
||
| You can add monitors through your application logic: | ||
|
|
||
| ```php | ||
| $variable = new VendorName\Skeleton(); | ||
| echo $variable->echoPhrase('Hello, VendorName!'); | ||
| use CleaniqueCoders\AppPulse\Models\Monitor; | ||
|
|
||
| $monitor = Monitor::create([ | ||
| 'owner_type' => \App\Models\User::class, | ||
| 'owner_id' => 1, // User or Application ID | ||
| 'url' => 'https://example.com', | ||
| 'interval' => 5, | ||
| 'ssl_check' => true, | ||
| ]); | ||
| ``` | ||
|
|
||
| ## Testing | ||
| To initiate a check for all monitors: | ||
|
|
||
| ```bash | ||
| php artisan apppulse:check | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## **Notifications** | ||
|
|
||
| **Notifications** will be sent to the owner of the monitor based on the configured notification channels (e.g., Email, Slack). You can customize the notification settings per user. | ||
|
|
||
| --- | ||
|
|
||
| ## **Testing** | ||
|
|
||
| Run the tests with: | ||
|
|
||
| ```bash | ||
| composer test | ||
| ``` | ||
|
|
||
| ## Changelog | ||
| --- | ||
|
|
||
| ## **Changelog** | ||
|
|
||
| See [CHANGELOG](CHANGELOG.md) for recent changes. | ||
|
|
||
| --- | ||
|
|
||
| ## **Contributing** | ||
|
|
||
| Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. | ||
| Please see [CONTRIBUTING](CONTRIBUTING.md) for details on contributing. | ||
|
|
||
| ## Contributing | ||
| --- | ||
|
|
||
| Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | ||
| ## **Security Vulnerabilities** | ||
|
|
||
| ## Security Vulnerabilities | ||
| For security concerns, review our [security policy](../../security/policy). | ||
|
|
||
| Please review [our security policy](../../security/policy) on how to report security vulnerabilities. | ||
| --- | ||
|
|
||
| ## Credits | ||
| ## **Credits** | ||
|
|
||
| - [:author_name](https://github.com/:author_username) | ||
| - [Nasrul Hazim Bin Mohamad](https://github.com/nasrulhazim) | ||
| - [All Contributors](../../contributors) | ||
|
|
||
| ## License | ||
| --- | ||
|
|
||
| ## **License** | ||
|
|
||
| This package is open-sourced software licensed under the [MIT License](LICENSE.md). | ||
|
|
||
| The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?php | ||
|
|
||
| // config for CleaniqueCoders/AppPulse | ||
| return [ | ||
|
|
||
| ]; |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.