Alt-Text 4 All

---

Table of Contents

• Overview
• Features
• Installation
• Usage
  • API Endpoints
• Contributing
• License

---

Overview

The AI-Driven Alt-Text Generator is a web service that automates the generation of alternative text for images on websites. It utilizes AI models to provide descriptive text for images, enhancing web accessibility. You can check a demo running here

Features

• Image Scraper: Extracts image URLs from a given website.
• AI-Generated Descriptions: Provides alternative text for images using AI models.

---

Installation

Clone the repository and navigate to the project directory. Install the required packages and start the server.

git clone https://github.com/jsugg/alt-text-generator.git
cd alt-text-generator
npm install
npm run dev

---

Usage

API Endpoints

Swagger Documentation

For detailed API documentation, visit /api-docs Swagger documentation.

Images

GET /api/scrapper/images or /api/v1/scrapper/images

• Summary: Returns the list of images found on a website.
• Parameters:
  • url: URLEncoded address of the website.
• Response: 200 OK with JSON containing image URLs.

---

Descriptions

GET /api/accessibility/description or /api/v1/accessibility/description

• Summary: Returns a description for a given image.
• Parameters:
  • image_source: URLEncoded address of the image.
  • model: AI model used ('clip' is currently available).
• Response: 200 OK with JSON containing image description.

---

Contributing

Contributions are welcome! Please read the contributing guidelines to get started.

License

This project is licensed under the MIT License. See the LICENSE file for details.