generated from spatie/package-skeleton-php
-
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
Showing
32 changed files
with
475 additions
and
554 deletions.
There are no files selected for viewing
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,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/banana-dev/banana-dev/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/banana-dev/banana-dev/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/banana-dev/banana-dev/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 was deleted.
Oops, something went wrong.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
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,13 +1,14 @@ | ||
.idea | ||
.php_cs | ||
.php_cs.cache | ||
.php-cs-fixer.cache | ||
.phpunit.result.cache | ||
.phpunit.cache | ||
build | ||
composer.lock | ||
coverage | ||
docs | ||
phpunit.xml | ||
psalm.xml | ||
vendor | ||
.php-cs-fixer.cache | ||
|
||
example/ |
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,4 +1,3 @@ | ||
# Changelog | ||
|
||
All notable changes to `:package_name` will be documented in this file. | ||
|
||
All notable changes to `banana-dev` will be documented in this file. |
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,66 +1,69 @@ | ||
# :package_description | ||
# title | ||
|
||
[![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) | ||
[![Tests](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/workflows/run-tests.yml) | ||
[![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 package can be used as to scaffold a framework agnostic package. Follow these steps to get started: | ||
## Using it | ||
|
||
1. Press the "Use 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. Try and limit it to a paragraph or two. Consider adding a small example. | ||
## Testing | ||
|
||
## Support us | ||
```sh | ||
mkdir example | ||
cd example | ||
composer init --name=banana-dev/example --description="" --author="" --autoload=src/ --repository='{"type":"path","url":"../"}' --license="" --require="banana-dev/banana-dev @dev" --require="guzzlehttp/guzzle:^7.8" --stability=dev --no-interaction | ||
``` | ||
|
||
[<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) | ||
Say yes to the discovery prompt. | ||
```sh | ||
composer install | ||
``` | ||
|
||
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). | ||
Create a `test.php` within `example/src` with your own API key. | ||
```php | ||
<?php | ||
|
||
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). | ||
require __DIR__ . '/../vendor/autoload.php'; | ||
|
||
## Installation | ||
use BananaDev\API; | ||
|
||
You can install the package via composer: | ||
$api = new API("11111111-1111-1111-1111-111111111111"); | ||
|
||
```bash | ||
composer require :vendor_slug/:package_slug | ||
``` | ||
$projects = $api->listProjects(); | ||
var_dump($projects); | ||
|
||
## Usage | ||
$project = $api->getProject($projects->json['results'][0]['id']); | ||
var_dump($project); | ||
|
||
```php | ||
$skeleton = new VendorName\Skeleton(); | ||
echo $skeleton->echoPhrase('Hello, VendorName!'); | ||
$updated = $api->updateProject($project->json['id'], [ | ||
'maxReplicas' => 3, | ||
]); | ||
var_dump($updated); | ||
``` | ||
|
||
## Testing | ||
## Development | ||
|
||
```bash | ||
composer test | ||
``` | ||
Install Homebrew | ||
|
||
## Changelog | ||
|
||
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. | ||
|
||
## Contributing | ||
```sh | ||
curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh | ||
``` | ||
|
||
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. | ||
Install PHP and Composer | ||
|
||
## Security Vulnerabilities | ||
```sh | ||
brew install php composer | ||
``` | ||
|
||
Please review [our security policy](../../security/policy) on how to report security vulnerabilities. | ||
Install dependencies | ||
|
||
## Credits | ||
```sh | ||
composer install | ||
``` | ||
|
||
- [:author_name](https://github.com/:author_username) | ||
- [All Contributors](../../contributors) | ||
Run tests | ||
|
||
## License | ||
```sh | ||
composer test | ||
``` | ||
|
||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information. | ||
Format code | ||
```sh | ||
composer format | ||
``` |
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,46 +1,52 @@ | ||
{ | ||
"name": ":vendor_slug/:package_slug", | ||
"description": ":package_description", | ||
"name": "banana-dev/banana-dev", | ||
"description": "A PHP client to interact with Banana's machine learning inference APIs", | ||
"keywords": [ | ||
":vendor_name", | ||
":package_slug" | ||
"Banana", "Banana.dev", "Banana client", "API wrapper", "SDK" | ||
], | ||
"homepage": "https://github.com/:vendor_slug/:package_slug", | ||
"homepage": "https://github.com/bananaml/banana-php-sdk", | ||
"license": "MIT", | ||
"authors": [ | ||
{ | ||
"name": ":author_name", | ||
"email": "[email protected]", | ||
"name": "Banana.dev", | ||
"email": "[email protected]", | ||
"role": "Developer" | ||
} | ||
], | ||
"require": { | ||
"php": "^8.1" | ||
"php": "^8.1", | ||
"php-http/discovery": "^1.17", | ||
"psr/http-client-implementation": "*", | ||
"psr/http-factory-implementation": "*", | ||
"ramsey/uuid": "^4.7" | ||
}, | ||
"require-dev": { | ||
:require_dev_testing, | ||
:require_dev_codestyle, | ||
"spatie/ray": "^1.28" | ||
"laravel/pint": "^1.0", | ||
"nyholm/psr7": "^1.8", | ||
"phpunit/phpunit": "^10.3.2", | ||
"spatie/ray": "^1.28", | ||
"symfony/http-client": "^6.3" | ||
}, | ||
"autoload": { | ||
"psr-4": { | ||
"VendorName\\Skeleton\\": "src" | ||
"BananaDev\\": "src" | ||
} | ||
}, | ||
"autoload-dev": { | ||
"psr-4": { | ||
"VendorName\\Skeleton\\Tests\\": "tests" | ||
"BananaDev\\Tests\\": "tests" | ||
} | ||
}, | ||
"scripts": { | ||
:scripts_testing, | ||
:scripts_codestyle | ||
"test": "vendor/bin/phpunit", | ||
"test-coverage": "vendor/bin/phpunit --coverage", | ||
"format": "vendor/bin/pint" | ||
}, | ||
"config": { | ||
"sort-packages": true, | ||
"allow-plugins": { | ||
:plugins_testing, | ||
"phpstan/extension-installer": true | ||
"phpstan/extension-installer": true, | ||
"php-http/discovery": false | ||
} | ||
}, | ||
"minimum-stability": "dev", | ||
|
Oops, something went wrong.