-
Notifications
You must be signed in to change notification settings - Fork 2
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
2 changed files
with
106 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) 2024 Sylius Sp. z o.o. | ||
|
||
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. |
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,87 @@ | ||
<p align="center"> | ||
<a href="https://sylius.com" target="_blank"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://media.sylius.com/sylius-logo-800-dark.png"> | ||
<source media="(prefers-color-scheme: light)" srcset="https://media.sylius.com/sylius-logo-800.png"> | ||
<img alt="Sylius Logo." src="https://media.sylius.com/sylius-logo-800.png"> | ||
</picture> | ||
</a> | ||
</p> | ||
|
||
GmvBundle | ||
========= | ||
|
||
Lightweight local command to calculate the Sylius instance GMV within a specific period | ||
|
||
## Features | ||
|
||
- Calculate GMV for a specified period. Default period is the last whole year. | ||
- Exclude taxes and shipping costs from GMV calculation. | ||
- Provide GMV in multiple currencies. | ||
|
||
## Installation | ||
|
||
Add the bundle to your Sylius project: | ||
|
||
```bash | ||
composer require sylius/gmv-bundle | ||
``` | ||
|
||
## Usage | ||
|
||
### Command Line | ||
|
||
You can calculate the GMV for a specified period using the Symfony console command: | ||
|
||
```bash | ||
bin/console sylius:gmv:calculate [periodStart] [periodEnd] | ||
``` | ||
|
||
The `periodStart` and `periodEnd` arguments are optional and should be in the `mm/YYYY` format. If not provided, the command will calculate the GMV for the last whole year. | ||
|
||
### Example | ||
|
||
The following command will calculate the GMV for the period from 1 January 2024 to 31 May 2024: | ||
|
||
```bash | ||
bin/console sylius:gmv:calculate 01/2024 5/2024 | ||
``` | ||
|
||
Example command output: | ||
|
||
``` | ||
GMV Calculation | ||
Period Start: 2024-01-01 | ||
Period End: 2024-05-31 | ||
GMV in USD: $3,247.28 | ||
``` | ||
Contributing | ||
------------ | ||
[This page](https://docs.sylius.com/en/latest/contributing/index.html) contains all the information about contributing to Sylius. | ||
Follow Sylius' Development | ||
-------------------------- | ||
If you want to keep up with the updates and latest features, follow us on the following channels: | ||
* [Official Blog](https://sylius.com/blog) | ||
* [Sylius on Twitter](https://twitter.com/Sylius) | ||
* [Sylius on Facebook](https://facebook.com/SyliusEcommerce) | ||
Bug tracking | ||
------------ | ||
Sylius uses [GitHub issues](https://github.com/Sylius/Sylius/issues). | ||
If you have found bug, please create an issue. | ||
MIT License | ||
----------- | ||
License can be found [here](https://github.com/Sylius/Sylius/blob/master/LICENSE). | ||
Authors | ||
------- | ||
See the list of [contributors](https://github.com/Sylius/Sylius/contributors). |