An open API service indexing awesome lists of open source software.

https://github.com/aanujkhurana/ai_articlesummary-react

OpenAI API SUMMARIZER - REACT, REDUX
https://github.com/aanujkhurana/ai_articlesummary-react

ai-applications openai-api rapid rapidapi react redux tailwindcss typescript

Last synced: 8 months ago
JSON representation

OpenAI API SUMMARIZER - REACT, REDUX

Awesome Lists containing this project

README

          

[![NPM Version](https://img.shields.io/npm/v/d3-org-chart.svg)](https://npmjs.org/package/d3-org-chart)
[![React](https://img.shields.io/badge/React-17.0.2-blue.svg)](https://reactjs.org/)
[![Redux](https://img.shields.io/badge/Redux-4.1.1-purple.svg)](https://redux.js.org/)
[![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-2.2.19-blueviolet.svg)](https://tailwindcss.com/)
[![RAPID API](https://img.shields.io/badge/RAPID%20API-Enabled-orange)](https://rapidapi.com)

# 📝 AI Article Summarizer

AI Summariser is a web application powered by the OpenAI model via the RAPID API, enabling users to summarize articles by URLs with a single click.

## 🚀 Live Demo

🔗 [Click here to visit the website](https://abouturl.netlify.app)


Screenshot
Screenshot
Screenshot

## 🛠️ Tech Stack

- React.js
- Redux Toolkit
- Tailwind CSS

## ✨ Features

- **Contemporary User Interface**: Boasting a contemporary and user-centric interface design, ensuring an intuitive browsing experience for all users.

- **Auto-Summarization**: Users can conveniently input the URL of extensive articles, with the web application utilizing AI to generate concise summaries of the content.

- **History Preservation via Local Storage**: The application incorporates a history feature, empowering users to locally save summaries, facilitating easy retrieval and management of their reading archives.

- **Clipboard Copying Functionality**: Facilitating effortless sharing and storage of summarized content by enabling users to copy it to their clipboard with ease.

- **Enhanced RTK Query API Requests**: Harnessing the advanced functionalities of Redux Toolkit (RTK) Query, the application executes API requests conditionally, streamlining data retrieval and management based on predefined criteria.

- **Solid Code Structure and Reusability**: The application is engineered with a focus on a sturdy code architecture and reusable components, ensuring scalability and ease of maintenance for future enhancements and expansions.

## 🛠️ Local Development

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 https://github.com/aanujkhurana/AI_ArticleSummary-React.git
cd AI_ArticleSummary-React
```

**Installation**

Install the project dependencies using npm:

```bash
npm 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=YOUR_RAPID_API_KEY
```

Replace `YOUR_RAPID_API_KEY` with your Rapid-API KEY credentials. [Rapid-API website](https://rapidapi.com).

**Running the Project**

```bash
npm run dev
```

Visit [http://localhost:5173](http://localhost:5173) to access the locally hosted application.

## Contribution

Contributions are welcome! If you want to contribute, please fork the repository and create a pull request.

## License

This project is licensed under the [MIT License](LICENSE).

## Acknowledgments

- Thanks to OpenAI for providing the powerful AI model.
- Special thanks to the contributors of React, Redux, Tailwind CSS, and other open-source libraries used in this project.