Fork me on GitHub

ContributingΒΆ

SHARQ is open source and released under the permissive MIT License. No software is complete and bugfree. If you feel something can be improved in SHARQ or would like to report bugs, feel free to do so. Pull requests are always welcome!

SHARQ consists of two components architecturally and with respect to codebases.

  1. The SHARQ Core which implements the core functionality of SHARQ which is rate limiting.
  2. The SHARQ Server which exposes an HTTP interface via Flask & Gevent.

The core rate limiting algorithm is implemented in Lua. The detailed explanation of the algorithm with the implementation details and the Redis data structures can be found in The Internals section.

Github Repository Links:

Navigation