Skip to content

Commit

Permalink
Merge pull request #13 from ghermans/main
Browse files Browse the repository at this point in the history
fixed license and readme
  • Loading branch information
ghermans authored Oct 20, 2021
2 parents ad7e6ac + 6ed675e commit 13f8b71
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 4 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Bagisto Europe

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,40 @@
</p>

<p align="center">
<img src="https://img.shields.io/badge/Version-1.0-blue.svg">
<img src="https://img.shields.io/badge/License-EULA-blue.svg">
<img alt="Github version" src="https://poser.pugx.org/bagisto-europe/stock-notify/v">
<img alt="GitHub license" src="https://img.shields.io/github/license/bagisto-europe/stock-notify">
</p>

## Topics
1. [Introduction](#introduction)
2. [Requirements](#requirements)
2. [Installation](#installation)
3. [Configuration](#configuration)

## Introduction
With this package you can keep an eye on your inventory.
Each time a customer purchases a product, the product's inventory is reduced and if the inventory reached the threshold, administrators will receive a export (xlsx) file hourly, daily or weekly in their mailbox.
With this package you can keep an eye on your inventory. The way it works is simple.
Each time a customer purchases a product, the product's inventory is reduced and if the inventory reached the threshold, administrators will receive a export (xlsx) file hourly, daily or weekly in their mailbox.

## Installation
```
composer require bagisto-eu/stock-notify
```
Once the package is installed run the following command
```
php artisan optimize
```

## Requirements
We only need to add a single **cron configuration** entry to our server that runs ´artisan schedule:run` every minute:

```
* * * * * cd /path-to-your-bagisto-folder && php artisan schedule:run >> /dev/null 2>&1`
```

## Configuration
1. Go to **Configure->Catalog->Inventory**.
2. Enable `Send a notification when products reach the treshold`.
3. Define the schedule for notifications.
4. Define the minimum stock (treshold).

![](docs/settings.PNG)
Binary file added docs/settings.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 13f8b71

Please sign in to comment.