README

Symfony bundle for rate limiting

Project

Getting Started

These instructions will help you install this library in your project and tell you how to use it.

Prerequisites

What things you need to install the software and how to install them

• PHP Project (PHP 8.2+)
• Symfony Project (Symfony 5.4+)

Installing

Add the library using Composer.

composer require iwf-web/rate-limiter-bundle

Usage

TODO: Describe how to use this library

Built With

• PHP - Programming Language
• Composer - Dependency Management

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and CONTRIBUTING.md for the process for submitting pull requests to us.

Static Code Analysis (PhpStan)

Have phpstan installed and run the following command to dry-run the analysis:

phpstan

In case errors are found, or have been fixed, it is easiest to just recreate the baseline with:

phpstan analyse --generate-baseline

Code Style (PHP-CS-Fixer)

Have PHP-CS-Fixer installed and run the following command to dry-run the code style fixer:

php-cs-fixer fix --dry-run -v --allow-risky=yes --diff --show-progress=dots

and to fix the code style run:

php-cs-fixer fix -v --allow-risky=yes --show-progress=dots

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

All the authors can be seen in the AUTHORS.md file.

Contributors can be seen in the CONTRIBUTORS.md file.

See also the full list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details

Acknowledgments

A list of used libraries and code with their licenses can be seen in the ACKNOWLEDGMENTS.md file.