README.md

ALTCHA Widget with Vite + React

This is an example React project using the ALTCHA widget.

Overview

ALTCHA is a free, open-source, self-hosted solution designed to protect websites, APIs, and online services from spam and unwanted content. It leverages a proof-of-work mechanism and is fully GDPR compliant, as it does not use cookies, fingerprinting, or tracking of any kind.

Get Started

To quickly get your project up and running with the ALTCHA widget, follow these steps:

1. Clone this repository and navigate to the project directory:

git clone https://github.com/altcha-org/altcha-starter-react-ts.git
cd altcha-starter-react-ts

2. Install the project dependencies:

npm install

3. Start the development server:

npm run dev

Creating a New Project Using Vite

If you prefer to create a new project from scratch, here are the steps:

1. Create a new Vite project with React and TypeScript template:

npm create vite@latest my-react-app -- --template react-ts

2. Navigate to your project directory:

cd my-react-app

3. Install the ALTCHA widget package:

npm install altcha --save

4. Import the altcha package in your project:

// src/main.tsx or appropriate file
import 'altcha';

5. Use the <altcha-widget> element in your component:

// ExampleComponent.tsx

const ExampleComponent = () => {
  return (
    <div>
      <h1>My React App with ALTCHA</h1>
      <altcha-widget challengeurl="https://your-challenge-url"></altcha-widget>
    </div>
  );
};

export default ExampleComponent;

Additional Configuration

Ensure your challengeurl points to the endpoint where ALTCHA's proof-of-work challenge is processed. Customize the component attributes as needed based on your specific use case.

Conclusion

With these steps, you should have a React project running with the ALTCHA widget integrated. This setup helps protect your application from spam and unwanted content efficiently and compliantly. For more details, visit the ALTCHA documentation.