Skip to content

aman-chhetri/TLDR.ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TLDR.ai – AI Powered Text Summarizer ✨

A modern AI-powered text summarization tool that effortlessly condenses articles, blogs, research papers, and documents into clear, easy-to-read summaries.


📖 Overview

TLDR.ai is a modern web application that automatically summarizes long-form text content into concise, readable summaries. The application allows users to input text directly or upload documents in various formats (TXT, PDF, DOCX). It now leverages the Google Gemini API to generate high-quality summaries efficiently.

The application name "TLDR" stands for "Too Long; Didn't Read" - a common internet acronym that perfectly captures the application's purpose of condensing lengthy content into digestible summaries.


To see a Demo Video: Click here!

TLDR.ai Homepage

You can check out the deployed app here: TLDR.ai


💡 Features

  • AI Summarization: Get concise summaries of any text using advanced AI models via the Google Gemini API.
  • File Upload: Supports .txt, .pdf, and .docx files. Extracts and summarizes content from your documents.
  • Character Counter: Live character count with a 10,000 character limit.
  • Copy & Download: Copy the summary to clipboard or download as a .txt file.
  • Dark/Light Mode: Toggle between beautiful dark and light themes.
  • Responsive Design: Works seamlessly on desktop, tablet, and mobile.
  • FAQ & About Pages: Learn more about the app and get answers to common questions.

📦 Tech Stack


🚀 Getting Started

1. Clone the repository

git clone https://github.com/yourusername/text-summarizer.git
cd text-summarizer

2. Install dependencies

npm install

3. Set up environment variables

Create a .env file in the root directory and add your Gemini API key:

VITE_GEMINI_API_KEY=your_gemini_api_key

4. Run the development server

npm run dev

Open http://localhost:5173 in your browser.


🗂️ Project Structure

src/
  [App.jsx] -> Main app with routing, layout, and pages
  [main.jsx] -> Entry point, Chakra UI, router setup
  [index.css] -> Custom styles components

src/components/ 
    [Logo.jsx] -> SVG logo component
    [Loader.jsx] -> Loader/spinner for async actions
    [TextSummarizer.jsx] -> Summarizer component

🤝 Feedback and Contribution

It is publicly open for any contribution. Bugfixes, new features, and extra modules are welcome.

  • To contribute to code: Fork the repo, push your changes to your fork, and submit a pull request.
  • To report a bug: If something does not work, please report it using GitHub Issues.

📬 Connect

© 2025 Aman Kshetri 👨‍💻

About

A modern AI-powered text summarization tool that effortlessly condenses articles, blogs, research papers, and documents into clear, easy-to-read summaries.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors