Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
enuenan committed Dec 12, 2023
1 parent 793423c commit 200d315
Show file tree
Hide file tree
Showing 27 changed files with 656 additions and 609 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/Enan/pathao-courier/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/Enan/pathao-courier/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/Enan/pathao-courier/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.

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 `pathao-courier` 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) Enan <emoammerfershid@gmail.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
74 changes: 41 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,72 @@
# :package_description

[![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:

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.
# A complete Laravel Package for Pathao Courier

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

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).
This is a laravel package for [Merchant Pathao Courier](https://merchant.pathao.com/) to create order. Now this package is supporting only with one store. Creating new store and create new order with them will be in newer version.

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

## Installation

You can install the package via composer:

```bash
composer require :vendor_slug/:package_slug
composer require enan/pathao-courier
```

You can publish and run the migrations with:

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

This is the contents of the published config file:

```php
return [
'pathao_base_url' => 'https://api-hermes.pathao.com/',
'pathao_client_id' => env('PATHAO_CLIENT_ID', ''),
'pathao_client_secret' => env('PATHAO_CLIENT_SECRET', ''),
'pathao_store_id' => env('PATHAO_STORE_ID', ''),
'pathao_store_name' => env('PATHAO_STORE_NAME', ''),
];
```

Optionally, you can publish the views using
<!-- Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag=":package_slug-views"
php artisan vendor:publish --tag="pathao-courier-views"
``` -->

Set the below value in your **.env** file

## .env

```
PATHAO_CLIENT_ID=
PATHAO_CLIENT_SECRET=
PATHAO_STORE_ID=
PATHAO_STORE_NAME=
```

## Usage

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
$pathaoCourier = new Enan\PathaoCourier();
echo $pathaoCourier->echoPhrase('Hello, Enan!');
```

## Testing
<!-- ## Testing
```bash
composer test
Expand All @@ -81,13 +82,20 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
Please review [our security policy](../../security/policy) on how to report security vulnerabilities. -->

## Credits

- [:author_name](https://github.com/:author_username)
- [All Contributors](../../contributors)
- [Moammer Farshid Enan](https://github.com/Enan)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Check me on

- [Portfolio](https://moammer-enan.com/)
- [Facebook](https://www.facebook.com/moammerfarshidenan)
- [GitHub](https://github.com/enuenan)
- [LinkedIn](https://www.linkedin.com/in/moammer-farshid/)
31 changes: 15 additions & 16 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "enan/pathao-courier",
"description": "A complete Laravel Package for Pathao Courier",
"keywords": [
":vendor_name",
"Enan",
"laravel",
":package_slug"
"pathao-courier"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/enan/pathao-courier",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Moammer Farshid Enan",
"email": "emoammerfershid@gmail.com",
"role": "Developer"
}
],
"require": {
"php": "^8.1",
"spatie/laravel-package-tools": "^1.14.0",
"guzzlehttp/guzzle": "^7.8",
"illuminate/contracts": "^10.0"
},
"require-dev": {
Expand All @@ -30,24 +30,23 @@
"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"
"phpstan/phpstan-phpunit": "^1.0"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"Enan\\PathaoCourier\\": "src/",
"Enan\\PathaoCourier\\Database\\Factories\\": "database/factories/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/",
"Enan\\PathaoCourier\\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-pathao-courier --ansi",
"prepare": "@php vendor/bin/testbench package:discover --ansi",
"build": [
"@composer run prepare",
Expand All @@ -73,10 +72,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"Enan\\PathaoCourier\\PathaoCourierServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"PathaoCourier": "Enan\\PathaoCourier\\Facades\\PathaoCourier"
}
}
},
Expand Down
74 changes: 74 additions & 0 deletions config/pathao-courier.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php

// config for Enan/PathaoCourier
return [

/*
|--------------------------------------------------------------------------
| Pathao Base Url
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/

'pathao_base_url' => 'https://api-hermes.pathao.com/',


/*
|--------------------------------------------------------------------------
| Pathao Client Id
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/

'pathao_client_id' => env('PATHAO_CLIENT_ID', ''),


/*
|--------------------------------------------------------------------------
| Pathao Client Secret
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/

'pathao_client_secret' => env('PATHAO_CLIENT_SECRET', ''),


/*
|--------------------------------------------------------------------------
| Pathao Store Id
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/

'pathao_store_id' => env('PATHAO_STORE_ID', ''),


/*
|--------------------------------------------------------------------------
| Pathao Store Name
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/

'pathao_store_name' => env('PATHAO_STORE_NAME', ''),
];
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

Loading

0 comments on commit 200d315

Please sign in to comment.