AI Summarizer

📋 Table of Contents

• ✨ Introduction
• ⚙️ Tech Stack
• 📝 Features
• 🚀 Quick Start

✨ Introduction

[EN] Summarize any kind of article with just one click using the powerful OpenAI model.

[FR] Résumez n'importe quel article en un seul clic en utilisant le puissant modèle OpenAI.

⚙️ Tech Stack

• React is a popular JavaScript library for building user interfaces, particularly single-page applications where data changes over time. React's component-based architecture allows developers to create reusable UI components, making development more efficient and the codebase easier to maintain. Its virtual DOM enhances performance by minimizing direct interactions with the browser's DOM.

• TypeScript is a statically typed superset of JavaScript that allows for early detection of errors and more robust, maintainable code. TypeScript's type system helps developers catch mistakes early during the development process, ensuring a more stable and reliable application.

• Redux Toolkit is a toolset for efficient state management in React applications, providing simplified APIs and reducing boilerplate code. It enhances code maintainability and scalability by promoting best practices for managing application state.

• OpenAI API is a powerful interface for accessing OpenAI's language models and capabilities, enabling developers to integrate advanced natural language processing (NLP) functionalities into their applications. It provides tools for generating text, answering questions, and performing other AI-driven tasks efficiently and effectively.

• Tailwind is a utility-first CSS framework that speeds up UI development by providing a set of pre-built utility classes. It allows developers to quickly build custom designs without writing traditional CSS, promoting rapid prototyping and design consistency.

📝 Features

👉 Modern User Interface: A modern and user-friendly interface, offering an intuitive experience for users.

👉 Summary Generation: Users can input the URL of a lengthy article, and the web app utilizes AI to provide a concise summary of the article content.

👉 History Saving with Local Storage: The app includes a history feature, allowing users to save summaries locally, providing a convenient way to revisit and manage their reading history.

👉 Copy to Clipboard Functionality: Enables users to easily share or store the summarized content by copying it to their clipboard.

👉 Advanced RTK Query API Requests: Utilizes the advanced capabilities of Redux Toolkit (RTK) Query for making API requests. These requests fire conditionally based on specific criteria, optimizing data fetching and management.

🚀 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Node.js
• npm (Node Package Manager)

Cloning the Repository

git clone {git remote URL}

Installation

Let's install the project dependencies, from your terminal, run:

npm install
# or
yarn install

Set Up Environment Variables

Create a new file named .env in the root of your project and add the following content:

VITE_RAPID_API_ARTICLE_KEY=

Replace the placeholder values with your actual respective account credentials:

• Rapid API

Running the Project

Installation will take a minute or two, but once that's done, you should be able to run the following command:

npm run dev
# or
yarn dev

Open http://localhost:3000 in your browser to view the project.