Skip to content

itsvijaysingh/Alt-Text-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alt Text Generator

Elevate your website's image accessibility, improve SEO, and enhance the overall user experience by effortlessly providing meaningful descriptions for your visuals. Alt Text Generator is an easy-to-use tool that uses artificial intelligence (AI) to automatically generate SEO-friendly alt text for images.

❓ How it Works

It leverages Microsoft's Azure Computer Vision API to analyze and describe the content of an image, providing information about the image content and context.

🔧 Requirements

Before you begin, ensure you have met the following requirements:

  • Node.js >= 16.14.0

🚀 Installation from source

Follow these steps to get the project up and running on your own machine.

  1. Clone the repository:

    git clone https://github.com/itsvijaysingh/alt-text-generator.git
  2. Install project dependencie using:

    npm install / npm i
  3. Set up your environment variables: To configure the project, create a .env file in the project root and add the following variables:

     - PORT: Port number for the server (Default: 5500).
     - AZURE_VISION_API_KEY: Your Azure Computer Vision API key.
     - AZURE_VISION_ENDPOINT: Your Azure Computer Vision API endpoint.
     - AZURE_VISION_MODEL_VERSION: (Optional) Azure model version (Default: 2023-02-01-preview).
     - AZURE_VISION_FEATURES: (Optional) Azure features to use (Default: caption).
     - AZURE_VISION_GENDER_NEUTRAL: (Optional) Enable gender-neutral captions  (Default: true).
  4. Run the Project To start the project, use npm:

    node app.js

💯 Usage

  • Upload an image using the provided interface.
  • Click the "Generate Alt Texts" button.
  • The AI will analyze the image and provide an alt text description.

🗒️ License

This project is licensed under the GNU General Public License (GPL-3.0). See the LICENSE file for details.