AvinAuth OTP Verification (Redis / Database)

A lightweight and customizable Laravel package for verifying mobile/email using one-time passwords (OTP) on Redis.

Verify your user mobile/email with a one-time password using both `Redis` and `Mysql Database`. ## Installation You can install the package via composer: Publish config file using: ## Configuration Configuration is located at config/avinauthconfig.php. Here's what you can adjust: `connection`: you can set your connection to redis or database as you wish > Note: The default connection is `redis` and we recommend to keep it that way specially for large scale projects. > If you are not using redis on your project and want to use `database` connection make sure to run `php artisan migrate` after installing the package. `code`: OTP code generation rules. `resend_delay` : Time delay (in seconds) before allowing another resend. `max_attemps`: Maximum verification attempts allowed. `max_resends`: Total resends allowed in one hour. ## Usage ### Send code to the user `$class` is your class that implements `AliArefAvin\AvinAuthPackage\Contracts\AvinAuthInterface` this `$class` contains your custom function named `send` that you use to send the code for users `(email|sms)` for exmaple your `$class` will be `new AuthenticateService()` ### Verify You can verify code with request validation. > `mobile` is your receiver which in this case is mobile. > Note: You can verify a code just once. so if you need to check code in two different requests then you should use something like the session to handle that. ## Credits & Inspiration 🙌 * This package is heavily inspired by the excellent work of the [Sanjab Verify package](https://github.com/sanjabteam/verify). Special thanks to the Sanjab team for their elegant design and contribution to the Laravel ecosystem. ## Contributing 🛠️ Contributions are welcome! * Fork the Project * Create a new branch * Add your changes * Submit a pull request 🙌 ## License 📝 This project is open-sourced under the MIT license.