Skip to content

bunopnu/captcherl

Repository files navigation

CaptchErl

An Erlang library that simplifies the process of verifying CAPTCHA responses for your web applications by providing easy-to-use functions for interacting with Cloudflare Turnstile, reCAPTCHA and hCaptcha.

Test Status Hex Version

Installation

Package can be installed by adding captcherl to your list of dependencies:

{deps, [{captcherl, "0.1.1"}]}.

Compatibility

This library requires Erlang/OTP version 25 or later.

Development

Prerequisites

  • rebar3: A widely used build tool for Erlang.
  • efmt: Code formatter for Erlang.

Quick Start

# Clone project
$ git clone https://github.com/bunopnu/captcherl.git
$ cd captcherl

# Build project
$ make build

# Run formatter
$ make format

# Run formatting check, dialyzer and xref
$ make check

# Run tests
$ make test

# Start an Erlang shell
$ make start
1> captcherl:verify(turnstile, {<<"1x0000000000000000000000000000000AA">>, <<"always true">>}).
true

Documentation

Online documentation is available at HexDocs.

Alternatively, you can generate documentation locally by running the following command:

$ make doc

License

CaptchErl is licensed under the MIT license.