Skip to content

Latest commit

 

History

History
132 lines (92 loc) · 4.39 KB

Readme.md

File metadata and controls

132 lines (92 loc) · 4.39 KB
Raw

AI Text Summarizer App

Welcome to the AI Text Summarizer App! This application leverages the power of Artificial Intelligence (AI) to provide concise summaries of lengthy texts. Whether you have an article, research paper, or any other text document, this app helps you summarize it quickly and effectively.

Table of Contents

Features

  • Text Summarization: Quickly summarize long texts with the help of Hugging Face's BART model.
  • Interactive UI: User-friendly interface to paste text and get summaries.
  • Sample Text: Clickable sample text for easy testing.
  • Responsive Design: Works seamlessly on both desktop and mobile devices.

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Backend: Node.js, Express.js
  • API: Hugging Face's BART model via REST API
  • Package Manager: npm

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine.

Prerequisites

Before you begin, ensure you have the following software installed on your local machine:

  • Node.js (v14 or higher)
  • npm (comes with Node.js)
  • Git (optional, for cloning the repository)

Installation

  1. Clone the repository (if you haven't already):

    git clone https://github.com/qaidjoharj53/AI-Text-Summarizer-App.git
cd AI-Text-Summarizer-App

  2. Install dependencies:

    npm install

  3. Set up environment variables:

    • Create a .env file in the root directory.
    • Add your Hugging Face API token in the .env file: 
      ACCESS_TOKEN=your_hugging_face_api_token

Running the App

  1. Start the backend server:

    node index.js

  2. Access the application:

    • Open your web browser and go to: http://localhost:3000

You should now see the AI Text Summarizer App running on your local machine.

Usage

  1. Enter text: Paste the text you want to summarize in the text area labeled "Paste in some text to summarize".
  2. Submit: Click the "Summarize" button.
  3. View summary: The summarized text will appear in the output text area below.

For testing purposes, you can click the "Click here" link to auto-fill a sample text.

Project Structure

├── public/              # Public directory for static files
│   ├── index.html       # Frontend HTML file
│   ├── stylesheet.css   # CSS file for styling
│   ├── script.js        # JavaScript file for frontend logic
├── index.js             # Main server file
├── summarize.js         # API interaction logic for summarization
├── .env                 # Environment variables (Not included in version control)
├── package.json         # Node.js package manifest
└── README.md            # Project documentation

Troubleshooting

If you encounter issues while running the app, consider the following:

  1. Dependencies: Ensure all dependencies are installed by running npm install.
  2. Node.js Version: Check if you're using a compatible Node.js version (v14 or higher).
  3. Environment Variables: Double-check your .env file to ensure your API key is correctly set.
  4. Console Errors: Check the console output in both your terminal and browser's Developer Tools for any error messages.

Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and create a pull request.

  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

License

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

Thank you for using the AI Text Summarizer App! If you have any questions or need further assistance, feel free to contact me.