https://github.com/spiral-packages/rate-limiter

A simple to use rate limiting abstraction which, in conjunction with your application's cache, provides an easy way to limit any action during a specified window of time.
https://github.com/spiral-packages/rate-limiter

Last synced: about 2 months ago
JSON representation

A simple to use rate limiting abstraction which, in conjunction with your application's cache, provides an easy way to limit any action during a specified window of time.

• Host: GitHub
• URL: https://github.com/spiral-packages/rate-limiter
• Owner: spiral-packages
• License: mit
• Created: 2022-06-18T07:44:05.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-09T12:44:32.000Z (about 1 year ago)
• Last Synced: 2024-04-11T23:50:58.006Z (9 months ago)
• Language: PHP
• Homepage:
• Size: 28.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A rate limiter for Spiral Framework.

[![PHP](https://img.shields.io/packagist/php-v/spiral-packages/rate-limiter.svg?style=flat-square)](https://packagist.org/packages/spiral-packages/rate-limiter)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/spiral-packages/rate-limiter.svg?style=flat-square)](https://packagist.org/packages/spiral-packages/rate-limiter)

[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/spiral-packages/rate-limiter/run-tests?label=tests&style=flat-square)](https://github.com/spiral-packages/rate-limiter/actions?query=workflow%3Arun-tests+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/spiral-packages/rate-limiter.svg?style=flat-square)](https://packagist.org/packages/spiral-packages/rate-limiter)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Requirements

Make sure that your server is configured with following PHP version and extensions:

- PHP 8.1+

- Spiral framework 3.0+

## Installation

You can install the package via composer:

```bash

composer require spiral-packages/rate-limiter

```

After package install you need to register bootloader from the package.

```php

protected const LOAD = [

    // ...

    \Spiral\RateLimiter\Bootloader\RateLimiterBootloader::class,

];

```

> Note: if you are using [`spiral-packages/discoverer`](https://github.com/spiral-packages/discoverer),

> you don't need to register bootloader by yourself.

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [butschster](https://github.com/butschster)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.