Skip to content

Commit

Permalink
Getting something going.
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpoulter committed Sep 14, 2019
1 parent 5e37e38 commit 501e9a0
Show file tree
Hide file tree
Showing 13 changed files with 4,995 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. In point form...
2. Please.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing

Contributions via Pull Requests are welcome and will be fully credited.

## Pull Requests

1. Fork the project.

1. `git clone` it and `composer install` the dependencies.

1. Create a feature branch.

1. **Add tests!** Your PR won't be accepted if it doesn't have tests.

1. Make the changes you are proposing.

1. Make sure the `README.md` and any other relevant documentation is kept up to date.

1. Make sure each individual commit in your pull request is meaningful. If you made multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

1. Push to your fork.

1. Open a pull request detailing your changes. **NB: One pull request per feature.**

## Testing

``` bash
$ phpunit
```
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Simple Squid
Copyright (c) 2019 Matthew Poulter

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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Vend SDK (a Laravel Package)
[![Latest Version](https://img.shields.io/github/release/simplesquid/laravel-vend-sdk.svg?style=flat-square)](https://github.com/simplesquid/laravel-vend-sdk/releases)
[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Total Downloads](https://img.shields.io/packagist/dt/simplesquid/laravel-vend-sdk.svg?style=flat-square)](https://packagist.org/packages/simplesquid/laravel-vend-sdk)

A Laravel provider package for our PHP SDK for Vend POS | https://docs.vendhq.com/

Contributions, issues and suggestions are very much welcome.
Expand All @@ -9,4 +13,12 @@ To install the SDK in your project you need to require the package via composer:

```bash
composer require simplesquid/laravel-vend-sdk
```

The package will automatically register itself.

To publish the config file to `config/vend.php` run:

```bash
php artisan vendor:publish --provider="SimpleSquid\LaravelVend\VendServiceProvider"
```
52 changes: 52 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"name": "simplesquid/laravel-vend-sdk",
"description": "A Laravel provider package for our PHP SDK for Vend POS.",
"type": "library",
"keywords": [
"laravel",
"php",
"sdk",
"point-of-sale",
"vend"
],
"license": "MIT",
"authors": [
{
"name": "Matthew Poulter",
"email": "[email protected]",
"role": "Developer"
}
],
"require": {
"php": "^7.2",
"illuminate/support": "~5.8.0|~6.0.0",
"simplesquid/vend-sdk": "^0.1.3"
},
"require-dev": {
"mockery/mockery": "^1.0",
"phpunit/phpunit": "^8.0",
"orchestra/testbench": "^4.0"
},
"autoload": {
"psr-4": {
"SimpleSquid\\LaravelVend\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"SimpleSquid\\LaravelVend\\Test\\": "tests"
}
},
"extra": {
"laravel": {
"providers": [
"SimpleSquid\\LaravelVend\\VendServiceProvider"
],
"aliases": {
"Vend": "providers\\LaravelVend\\VendFacade"
}
}
},
"minimum-stability": "dev",
"prefer-stable": true
}
Loading

0 comments on commit 501e9a0

Please sign in to comment.