An open API service indexing awesome lists of open source software.

https://github.com/yariksav/adonis-captcha

Recaptcha module for AdonisJS framework
https://github.com/yariksav/adonis-captcha

Last synced: 4 months ago
JSON representation

Recaptcha module for AdonisJS framework

Awesome Lists containing this project

README

        

# Adonis Captcha Provider

This package helps you to use recaptcha in your project

## Setup

Install the package from npm

```npm
adonis install adonis-captcha
```

Then register provider in start/app.js:

```javascript
const providers = [
...
'adonis-captcha/providers/CaptchaProvider'
]
```

## Usage as middleware

Add row in start/kernel.js
```js
const namedMiddleware = {
...
recaptcha: 'Adonis/Middleware/Captcha',
}
```
Then in your route

```js
Route.post('account/register', 'AccountController.register').middleware(['recaptcha'])
```
## Use in tests

```js
const Captcha = use('Capptcha')

...

test('try to register new user', async ({ assert, client}) => {
Captcha.fake()
const user = await User.create(newUser)

const response = await client.post('account/register')
.send({
username: 'test'
})
.end()

response.assertStatus(200)

Captcha.restore()
})
```

## Use directly
```js
const Captcha = use('Captcha')
await Captcha.validate(request.input('recaptcha-token'))
```

validate will throw Error when recaphca is incorrect