Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhairyash-1/url-content-summarizer
This project is a Web URL Summarizer, utilizing Puppeteer for web scraping and the ChatGPT API to deliver concise summaries of extracted content. Built with React, TypeScript, and ExpressJS.
https://github.com/dhairyash-1/url-content-summarizer
browserless chatgpt-api epxressjs puppeteer reactjs typescript
Last synced: 3 days ago
JSON representation
This project is a Web URL Summarizer, utilizing Puppeteer for web scraping and the ChatGPT API to deliver concise summaries of extracted content. Built with React, TypeScript, and ExpressJS.
- Host: GitHub
- URL: https://github.com/dhairyash-1/url-content-summarizer
- Owner: Dhairyash-1
- Created: 2024-01-10T10:26:20.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-01-13T09:16:31.000Z (12 months ago)
- Last Synced: 2024-01-13T19:48:58.394Z (12 months ago)
- Topics: browserless, chatgpt-api, epxressjs, puppeteer, reactjs, typescript
- Language: TypeScript
- Homepage: https://url-summarizer.netlify.app/
- Size: 152 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# URL Summarization Project
This project provides a web application for summarizing the content of a given URL. It utilizes React for the frontend, Express with TypeScript for the backend, and integrates OpenAI API for summarization and Puppeteer for web scraping with Browserless for headless browsing.
# Screenshot
## Features
- Web scraping to extract content from a given URL using Puppeteer with Browserless.
- Summarization of extracted content using OpenAI API.
- React-based frontend for user interaction.
- Express server with TypeScript for backend implementation.
## Live Demo
Explore the live demo [here](https://url-summarizer.netlify.app/).
## Getting Started
### Prerequisites
Before running the project, make sure you have the following installed:
- [Node.js](https://nodejs.org/)
- [npm](https://www.npmjs.com/)
- [Browserless](https://www.browserless.io/) account for Puppeteer.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/your-username/url-summarization-project.git
```
2. Install dependencies for both the frontend and backend:
```bash
cd url-summarization-project
cd client && npm install
cd ../server && npm install
```
### Configuration
1. Set up environment variables:
Create a .env file in the server directory and add the following:
```bash
BLESS_TOKEN=your_browserless_token
OPENAI_API_KEY=your_openai_api_key
CORS_ORIGIN=your_frontend_url
```
### Running the Application
1. Start the backend server:
```bash
cd server && npm start
```
2. Start the frontend:
```bash
cd client && npm start
```
3. Visit http://localhost:5173 in your browser to access the application.
### Usage
1. Enter a URL in the input field.
2. Click the "Summarize" button.
3. The application will extract the content from the URL, summarize it using OpenAI, and display the result.