captcha-for-all-api

Tries to provide captcha functionality everywhere where there is none

· Report Bug · Request Feature

About The Project

Small docker setup to provide captcha functionality everywhere where there is none. Utilizes NestJS.

Getting Started Develop

To get a local copy up and running follow these simple steps.

Prerequisites

• Docker
• Docker Compose

Installation

1. Clone the repo

git clone https://github.com/beuluis/captcha-for-all-api.git --branch develop

2. Start docker-compose

docker-compose up --build

3. Call the api with localhost:{your port} as base url

Customization

1. Create a .env file

touch .env

2. Overwrite variables as you like (format: {variable name}={variable value})

Variable	Description	Default value	Required
INSPECT_PORT	Node inspect port	9229	false
PORT	Which port is mapped to your host machine	3300	false
CAPTCHA_SITEKEY	HCapthca sitekey	0x0000000000000000000000000000000000000000	false
CAPTCHA_SECRET	HCapthca secret	10000000-ffff-ffff-ffff-000000000001	false

Endpoint dokumentation

The endpoints are documented in swagger. You can navigate to swagger on your local instance, like localhost:{your port}/api. Or view them here.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Luis Beu - [email protected]