Skip to content

sumz is a web application built using React and the OpenAI API that allows users to summarize articles by simply pasting the article URL into the input box. The app also includes local storage, allowing users to browse their previously summarized articles and URLs.

Notifications You must be signed in to change notification settings

Chennareddy44/sumz

Repository files navigation

sumz ( Open AI Article Summarizer )

1. About The Project

This is a React-based web application that allows users to summarize articles using the OpenAI API. Users can simply paste the URL of an article into the input box, press enter, and the application will generate a summary of the article. The application also uses local storage to store all data, allowing users to browse their previous articles and URLs.

sumz

Live Preview

2. Technologies Used

React : A popular JavaScript library for building user interfaces.

Redux Toolkit : A library that provides a simple and efficient way to manage state in React applications.

Vite : A build tool that allows for fast and efficient development and production builds.

TailwindCSS : A utility-first CSS framework that provides pre-defined CSS classes for common styles.

OpenAI API : An API that provides access to a variety of machine learning models, including text summarization.

3. Usage

The sumz application provides the following features:

Ability to summarize articles using the OpenAI API

Local storage for storing all data, including previous articles and URLs

To use the application, follow these steps:

  1. Open the application in your web browser.

  2. Paste the URL of an article into the input box.

  3. Press enter and wait for the article to be summarized.

  4. The summary will appear on the screen.

sumz is useful to quickly summarize an article without having to read the entire thing.

4. Set up locally

To get started with this project, follow these steps:

Clone this repository

git clone https://github.com/Chennareddy44/sumz.git

Install the dependencies

cd sumz

npm install

Run the development server

npm run dev

The application will be available at http://localhost:5173/

5. Contributing

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository

  2. Create a new branch (git checkout -b feature/your-feature-name)

  3. Make your changes and commit them (git commit -am 'Add some feature')

  4. Push to the branch (git push origin feature/your-feature-name)

  5. Create a new Pull Request

About

sumz is a web application built using React and the OpenAI API that allows users to summarize articles by simply pasting the article URL into the input box. The app also includes local storage, allowing users to browse their previously summarized articles and URLs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published