Skip to content

Create readme file for recaptcha #5685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 17, 2024
Merged

Create readme file for recaptcha #5685

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78d0a57
readme file for recaptcha
ekin-burak Oct 17, 2024
2350c75
file tree update
ekin-burak Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions plugins/recaptcha/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Recaptcha plugin

The reCAPTCHA plugin for Countly is designed to integrate Google's reCAPTCHA service into your Countly analytics platform. This plugin helps protect your application from spam and abuse while ensuring a smooth user experience. It provides an easy-to-use API for managing reCAPTCHA verification and includes robust functionality for displaying reCAPTCHA challenges.

## File Structure

File structure follows usual Countly plugin structure
```
recaptcha/
├── api/
│ └── api.js
├── frontend/
│ ├── public
│ │ ├── javascripts
│ │ │ ├── countly.models.js
│ │ │ └── countly.views.js
│ │ ├── localization # all localization files
│ │ └── stylesheets
│ └── app.js # reCAPTCHA integration for Countly login
├── install.js
├── package.json
├── README.md
└── tests.js # plugin tests
```

## Configuration

The reCAPTCHA plugin for Countly requires a site key and a secret key from the Google reCAPTCHA admin console. Both keys are essential for the plugin to function correctly and ensure secure verification. In the recaptcha settings in Countly, there is a link to the Google reCAPTCHA admin page.
Loading