Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basedhound/summarizer-ai_react
Summarize any article with one click using the powerful OpenAI model. This web app features a modern interface, AI-generated summaries, local summary saving, and copy-to-clipboard functionality.
https://github.com/basedhound/summarizer-ai_react
ai openai rapid-api react redux-toolkit summarizer vite
Last synced: about 3 hours ago
JSON representation
Summarize any article with one click using the powerful OpenAI model. This web app features a modern interface, AI-generated summaries, local summary saving, and copy-to-clipboard functionality.
- Host: GitHub
- URL: https://github.com/basedhound/summarizer-ai_react
- Owner: basedhound
- Created: 2023-06-24T09:39:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-06T10:50:25.000Z (5 months ago)
- Last Synced: 2024-11-09T03:24:26.153Z (about 2 months ago)
- Topics: ai, openai, rapid-api, react, redux-toolkit, summarizer, vite
- Language: JavaScript
- Homepage: https://summarize-fv.netlify.app
- Size: 595 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
AI Summarizer
##
đź“‹ Table of Contents
- ✨ [Introduction](#introduction)
- ⚙️ [Tech Stack](#tech-stack)
- đź“ť [Features](#features)
- 🚀 [Quick Start](#quick-start)
**[EN]** Summarize any article with one click using the powerful OpenAI model. This web app features a modern interface, allowing users to input article URLs for concise AI-generated summaries. It saves summaries locally for easy history management and offers copy-to-clipboard functionality for effortless sharing. Advanced RTK Query API requests optimize data fetching and management.
**[FR]** Résumez n'importe quel article en un clic grâce au puissant modèle OpenAI. Cette application web offre une interface moderne et conviviale, permettant aux utilisateurs d'entrer des URL d'articles pour obtenir des résumés concis générés par l'IA. Les résumés sont enregistrés localement pour une gestion facile de l'historique, et une fonction de copie dans le presse-papiers facilite le partage. Les requêtes API avancées de RTK Query optimisent la récupération et la gestion des données.
- [**React**](https://react.dev/reference/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**](https://www.typescriptlang.org/docs/) 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**](https://redux-toolkit.js.org/introduction/getting-started) 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**](https://platform.openai.com/docs/api-reference/introduction) 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**](https://v2.tailwindcss.com/docs) 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.
👉 **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.
Follow these steps to set up the project locally on your machine.
**Prerequisites**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)
**Cloning the Repository**
```bash
git clone {git remote URL}
```
**Installation**
Let's install the project dependencies, from your terminal, run:
```bash
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:
```env
VITE_RAPID_API_ARTICLE_KEY=
```
Replace the placeholder values with your actual respective account credentials:
- [Rapid API](https://rapidapi.com/)
**Running the Project**
Installation will take a minute or two, but once that's done, you should be able to run the following command:
```bash
npm run dev
# or
yarn dev
```
Open [`http://localhost:5173`](http://localhost:5173) in your browser to view the project.