Commission Calculator is a development tool designed to compute commission rates for various business scenarios. It provides a flexible and configurable system for calculating commissions with customizable rates.
The application is configured using YAML files located in the config directory. There is example .env file that could be used as a starting point.
Configure the desired commission rates in the configuration file and use the calculator service to compute commissions based on your business rules.
The application is currently in development mode. To get started:
- Clone the repository.
- Configure your settings in
config/services.yml. - Copy
.env-exampleto.envand configure your API keys (not included). Beware of rate limits! - Run the application
./bin/calculate data/input.txt(or use your own input file).
# Using default output location (data/output.txt)
./bin/calculate input.txt
# Using custom output location
./bin/calculate input.txt /custom/path/output.txt- The application is designed to be run in a terminal.
- You need your own API keys for the services used.
- Beware of rate limits! Some free services have very low limits (e.g. 5 requests per hour).
To run tests locally:
# Run tests with coverage
composer test
# View coverage report
open tests/coverage/index.htmlThe project maintains 100% code coverage. Coverage reports are:
- Generated automatically on each push
- Available in the GitHub Actions artifacts
- Published to Codecov
MIT License. See LICENSE for more details.