Skip to content

Seerxt01/NPL-Text-Summarizer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 NLP Text Summarizer

NLP Text Summarizer Banner

An advanced, interactive React app for extractive document summarization using TF-IDF ranking and sentence extraction. Built for speed, clarity, and modern NLP experimentation.


✨ Features

  • Extractive Summarization: Uses TF-IDF-inspired ranking to select the most important sentences.
  • Key Points & Ranked Sentences: Instantly switch between concise bullet points and full ranked sentences.
  • Quality Metrics: Automatic evaluation for coherence, relevance, informativeness, and conciseness.
  • Downloadable Summaries: Export your results as a text file for sharing or further analysis.
  • Modern UI: Clean, responsive interface built with React 19 and TypeScript.

📦 Tech Stack

  • React 19
  • TypeScript
  • NLP Algorithms (TF-IDF, sentence extraction)

🚀 Quick Start

Prerequisites

  • Node.js (v16 or higher recommended)
  • npm

Installation

git clone https://github.com/Seerxt01/NPL-Text-Summarizer.git
cd NPL-Text-Summarizer
npm install

Usage

You can use any React-compatible build tool (Vite, CRA, Next.js, etc.). Import and render the NLPTextSummarizer component in your app:

import NLPTextSummarizer from './NLPTextSummarizer';

function App() {
	return <NLPTextSummarizer />;
}

📝 How It Works

  1. Paste or upload your document text.
  2. Summarize: Instantly view key points or ranked sentences.
  3. Evaluate: See metrics for summary quality.
  4. Download: Export your summary for sharing or research.

🛠️ Customization

  • Adjust summary length, number of sentences, and system prompt in the component state.
  • UI uses standard HTML elements for easy styling and integration.

📁 Project Structure

  • NLPTextSummarizer.tsx — Main React component
  • package-lock.json — Dependency lock file

📚 Dependencies

  • react ^19.1.1
  • react-dom ^19.1.1
  • @types/react ^19.1.13
  • @types/react-dom ^19.1.9

💡 Why Use This Project?

  • Educational: Learn how modern NLP techniques work in practice.
  • Research: Prototype and test extractive summarization ideas quickly.
  • Productivity: Summarize long documents in seconds.

📜 License

MIT — Free for personal and commercial use.

NLP Text Summarizer

A simple React-based extractive document summarizer using TF-IDF ranking and sentence extraction. This project demonstrates key NLP techniques for summarizing text and evaluating summary quality.

Features

  • Extractive summarization using TF-IDF-inspired ranking
  • Key points and ranked sentences display
  • Evaluation metrics: coherence, relevance, informativeness, conciseness
  • Download summary as a text file
  • Built with React 19

Getting Started

Prerequisites

  • Node.js (v16 or higher recommended)
  • npm

Installation

  1. Clone the repository:
    git clone https://github.com/Seerxt01/NPL-Text-Summarizer.git
    cd NPL-Text-Summarizer
  2. Install dependencies:
    npm install

Running the App

You can use any React-compatible build tool (e.g., Vite, Create React App, Next.js) to run the app. For a quick start, add this component to your React project and render it in your main app file.

Project Structure

  • NLPTextSummarizer.tsx: Main React component implementing the summarizer UI and logic
  • package-lock.json: Dependency lock file (React 19, TypeScript types included)

Dependencies

  • react ^19.1.1
  • react-dom ^19.1.1
  • @types/react ^19.1.13
  • @types/react-dom ^19.1.9

Usage

  1. Paste or upload your document text.
  2. Click to summarize and view key points or ranked sentences.
  3. Download the summary as a text file.

Customization

  • You can adjust summary length, number of sentences, and system prompt in the component state.
  • UI uses standard HTML elements for easy styling and integration.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published