Skip to content

Latest commit

 

History

History
136 lines (96 loc) · 4.17 KB

README.md

File metadata and controls

136 lines (96 loc) · 4.17 KB
Raw

ForkTheCaptcha

Welcome to ForkTheCaptcha! 🎉
This repository is a simple web project made with HTML, CSS, and JavaScript where a CAPTCHA is displayed to verify user interaction. Feel free to explore, contribute, and fork it for Hacktoberfest 2024! 🚀


🎯 Project Overview

CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) is a crucial feature used to prevent bots from abusing web forms and functionalities. This project is designed to demonstrate how to implement a basic CAPTCHA system using client-side technologies.


🌟 Features

  • Dynamically generated CAPTCHA.
  • Simple and clean UI.
  • Designed for beginners to learn and contribute during Hacktoberfest 2024!

🛠️ Tech Stack

  • HTML: Structure of the webpage.
  • CSS: Styling and layout.
  • JavaScript: CAPTCHA generation and validation logic.

🚀 Getting Started

  1. Fork this repository: Click the "Fork" button on the top right corner of this page and create your own copy of the repository.

  2. Clone your fork:

git clone https://github.com/your-username/ForkTheCaptcha.git
  1. Navigate into the project directory:
cd ForkTheCaptcha
  1. Open the index.html file in your browser to see the CAPTCHA in action.

📝 How It Works

  1. CAPTCHA Generation: The JavaScript function generates a random sequence of characters (alphanumeric) displayed as an image.

  2. User Input: The user is prompted to enter the characters from the CAPTCHA image into a text field.

  3. Validation: If the user input matches the CAPTCHA, the form is successfully submitted. Otherwise, the user is asked to try again.


🧑‍💻 How to Contribute

We'd love for you to contribute to ForkTheCaptcha and make it better! You can add new features, make desgin responsive, fix any issue or bug, change styling as long as code doesn't break!

To contribute:

  1. Fork & Star⭐ this repository : https://github.com/AdityaSinha2305/ForkTheCaptcha.git

  2. Clone the forked repository :

git clone https://github.com/your-username/ForkTheCaptcha.git
  1. Navigate to project directory :
cd ForkTheCaptcha
  1. Create a new branch :
git checkout -b your-feature-branch
  1. Make your changes and commit :
git add .
git commit -m "Proper commit message"
  1. Push your fork :
git push origin your-feature-branch
  1. Open a pull request and we'll review it!

🛡️ Contribution Rules

To ensure a smooth contribution process, please follow these rules:

  • Create a separate branch for each feature or fix to keep changes isolated.
  • Write clear and descriptive commit messages.
  • Test your changes before submitting a pull request.
  • Do not add any build steps, e.g., npm install (I want to keep this repo simple and static)
  • Do not remove other contents.
  • Try to keep pull requests small to minimize merge conflicts.
  • Be respectful and constructive in your pull request comments and reviews.

🔄 Sync Your Fork to Avoid Conflicts

To avoid merge conflicts, ensure your fork is up-to-date with the original repository before making any changes. Here’s how to sync your fork:

  1. Add the original repository as a remote (if not already added):
git remote add upstream https://github.com/AdityaSinha2305/ForkTheCaptcha.git
  1. Merge the changes into your local fork:
git checkout main
git pull upstream main
  1. Push the updated main branch to your fork:
git push origin main

After syncing, you can create a new branch from the updated main branch or can merge this updated main branch into your feature branch and start working on your changes!


🎉 Hacktoberfest 2024

This project is participating in Hacktoberfest 2024. Contribute to this repository and don't forget to register at hacktoberfest.com and start submitting pull requests.


📄 License

This project is open source and available under the MIT License.


🎊 Don't forget to explore the other interesting repo !!