Skip to content

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

13 Commits

Folders and files

Repository files navigation

πŸš€ FlashRead - AI-Powered Article Summarizer

FlashRead Logo

Read faster. Understand more.

Transform lengthy articles and documents into clean, focused summaries in seconds.

Next.js TypeScript Tailwind CSS Groq

✨ Features

  • πŸ”— URL Summarization - Paste any article URL and get instant summaries
  • πŸ“ Text Processing - Summarize any text content directly
  • ⚑ Dual AI Engines - Choose between RapidAPI and Groq for optimal results
  • πŸ“ Flexible Length - Quick, balanced, or detailed summaries
  • 🎨 Beautiful UI - Clean, responsive design with dark mode support
  • πŸ“± Mobile First - Optimized for all devices
  • πŸ”’ Privacy Focused - Local storage, no data tracking
  • πŸ“š Smart History - Access your previous summaries anytime
  • πŸ“„ Export Options - Copy to clipboard or download as Markdown

🎯 Perfect For

  • Students - Quickly understand research papers and articles
  • Professionals - Stay updated with industry news efficiently
  • Researchers - Process large amounts of content faster
  • Content Creators - Get key insights from competitor content
  • Anyone - Who wants to read smarter, not harder

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • API keys (see setup below)

Installation

```bash

Clone the repository

git clone https://github.com/yourusername/flashread.git cd flashread

Install dependencies

npm install

Set up environment variables

cp .env.example .env.local ```

Environment Setup

Create a `.env.local` file with your API keys:

```env

RapidAPI Key for Article Extractor and Summarizer

NEXT_PUBLIC_RAPIDAPI_KEY=your_rapidapi_key_here

Groq API Key for AI text summarization

NEXT_PUBLIC_GROQ_KEY=your_groq_key_here ```

Getting API Keys

πŸ”‘ RapidAPI Key

  1. Visit RapidAPI Article Extractor
  2. Sign up and subscribe to the API
  3. Copy your X-RapidAPI-Key

πŸ”‘ Groq API Key

  1. Go to Groq Console
  2. Create an account and generate an API key
  3. Copy your API key

Run Development Server

```bash npm run dev ```

Open http://localhost:3000 and start summarizing! πŸŽ‰

πŸ› οΈ Tech Stack

Frontend

  • Next.js 15 - React framework with App Router
  • TypeScript - Type-safe development
  • Tailwind CSS - Utility-first styling
  • shadcn/ui - Beautiful, accessible components
  • Lucide React - Clean, consistent icons

AI & APIs

  • Groq - Lightning-fast AI inference
  • RapidAPI - Article extraction and summarization
  • AI SDK - Unified AI integration

Features

  • Sonner - Beautiful toast notifications
  • next-themes - Dark mode support
  • Radix UI - Accessible primitives

πŸ“± Screenshots

Desktop View
Desktop Experience

Mobile View
Mobile Experience

🎨 Design Philosophy

FlashRead is built with a mobile-first, accessibility-focused approach:

  • Orange-dominant theme - Energetic and modern
  • Responsive design - Beautiful on all screen sizes
  • Intuitive UX - No learning curve required
  • Fast performance - Optimized for speed
  • Privacy first - Your data stays with you

πŸ”§ Usage

URL Summarization

  1. Select URL mode
  2. Paste any article URL
  3. Choose your preferred summary length
  4. Select processing engine (RapidAPI recommended for URLs)
  5. Click Summarize ✨

Text Summarization

  1. Select Text mode
  2. Paste your content
  3. Adjust length and engine settings
  4. Get your summary instantly

Advanced Options

  • Quick (3-4 sentences) - For rapid overviews
  • Balanced (6-8 sentences) - Perfect middle ground
  • Detailed (10-12 sentences) - Comprehensive analysis

🀝 Contributing

We love contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch (`git checkout -b feature/amazing-feature`)
  3. Commit your changes (`git commit -m 'Add amazing feature'`)
  4. Push to the branch (`git push origin feature/amazing-feature`)
  5. Open a Pull Request

Development Guidelines

  • Follow TypeScript best practices
  • Use Tailwind for styling
  • Ensure mobile responsiveness
  • Add proper accessibility attributes
  • Test on multiple devices

πŸ“„ License

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

πŸ™ Acknowledgments

  • Vercel - For the amazing deployment platform
  • shadcn - For the beautiful component library
  • Groq - For lightning-fast AI inference
  • RapidAPI - For reliable article extraction
  • The Open Source Community - For inspiration and tools

πŸ“ž Support

Having issues? We're here to help!

πŸš€ Deployment

Deploy to Vercel (Recommended)

Deploy with Vercel

  1. Click the deploy button above
  2. Connect your GitHub account
  3. Add your environment variables
  4. Deploy! πŸŽ‰

Manual Deployment

```bash

Build the project

npm run build

Start production server

npm start ```

πŸ“Š Roadmap

  • PDF Support - Summarize PDF documents
  • Batch Processing - Multiple URLs at once
  • Custom Prompts - Personalized summarization styles
  • Team Collaboration - Share summaries with your team
  • Browser Extension - Summarize any page with one click
  • API Access - Integrate FlashRead into your apps

Made with ❀️ by Fred Juma

Website β€’ Twitter β€’ Email

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages