Skip to content

Summize is an open-source article summarizer that transforms lengthy articles into clear and concise summaries using OpenAI's GPT-4. Simplify your reading and save time by getting the gist of any article quickly and efficiently.

Notifications You must be signed in to change notification settings

KDvs123/ai-summeriser

Repository files navigation

🌟 Summize: Article Summarizer 🌟

React Redux TailwindCSS License: MIT

Summize is an open-source article summarizer that transforms lengthy articles into clear and concise summaries using OpenAI's GPT-4. Simplify your reading and save time by getting the gist of any article quickly and efficiently.

✨ Features

  • 📝 Article Summarization: Extract and summarize content from any URL.
  • 🗂️ URL History: Keep track of previously summarized articles.
  • 📋 Clipboard Copy: Easily copy URLs to the clipboard.
  • 💻 Responsive Design: User-friendly interface with responsive design.
  • 🔄 State Management: Uses Redux Toolkit for state management.
  • 🌐 API Integration: Leverages RapidAPI for article extraction and summarization.

🎥 Demo Video

Watch the demo video to see Summize in action:

Untitled.video.-.Made.with.Clipchamp.1.mp4

🛠️ Tech Stack

  • Frontend: React
  • State Management: Redux
  • Styling: TailwindCSS
  • Backend: RapidAPI
  • APIs: OpenAI GPT-4

🚀 Getting Started

📋 Prerequisites

Make sure you have the following installed on your local machine:

  • Node.js (v14 or higher)
  • npm (v6 or higher)

🔧 Installation

  1. Clone the repository:

    git clone https://github.com/KDvs123/ai-summerizer.git
    cd summize
  2. Install dependencies:

    npm install
  3. Setup RapidAPI Key:

    • Create a .env file in the root directory.
    • Add your RapidAPI key in the .env file:
      VITE_RAPID_API_ARTICLE_KEY=your-rapidapi-key
  4. Run the development server:

    npm run dev
  5. Open your browser and navigate to:

    http://localhost:3000
    

📝 Usage

  1. Enter a URL: Paste the URL of the article you want to summarize in the input field.
  2. Submit: Click the submit button to fetch and summarize the article.
  3. View Summary: The summarized content will be displayed below the input field.
  4. Copy URL: Use the copy button to easily copy URLs to your clipboard.
  5. Browse History: Click on previously summarized articles to quickly view their summaries.

📂 Project Structure

Screenshot 2024-06-01 185357

🤝 Contributing

Contributions are welcome! Please follow these steps to contribute:

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

📜 License

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

🙏 Acknowledgements

📬 Contact

For any questions or suggestions, feel free to reach out:


Enjoy summarizing articles with Summize! 😊

About

Summize is an open-source article summarizer that transforms lengthy articles into clear and concise summaries using OpenAI's GPT-4. Simplify your reading and save time by getting the gist of any article quickly and efficiently.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published