ArticleInsightGuide: Guided Tour of Your Article Analysis Tool

Watchers Forks Star

Issue Open Pull Request

License

Table of Contents

Overview

ArticleInsightGuide is an innovative web application that enhances the user experience by providing a comprehensive and interactive analysis of articles, coupled with an intuitive guided tour powered by Shepherd.js. The guided tour feature aims to familiarize users with the application's functionalities, ensuring a seamless and efficient exploration of its capabilities.

ArticleInsightGuide leverages advanced natural language processing (NLP) techniques to deliver accurate and insightful analyses of articles from popular platforms such as Dev.to and Medium. However, the standout feature of ArticleInsightGuide is its interactive guided tour, which guides users through the application's various components and features, providing step-by-step instructions and highlighting key elements of the user interface.

Key Features

Interactive Guided Tour

The cornerstone of ArticleInsightGuide is its interactive guided tour, implemented using the Shepherd.js library. This feature provides users with a step-by-step walkthrough of the application's functionalities, ensuring they can navigate and utilize the tool effectively. The tour highlights key features, explains their purpose, and guides users through the application's workflow, making the user experience seamless and intuitive.

Throughout the application, users will encounter a "Guide Me" button, which initiates the guided tour. This tour is designed to be context-aware, presenting relevant information and instructions based on the user's current location within the application.

Content Categorization

ArticleInsightGuide's intelligent categorization system employs advanced algorithms to classify articles into relevant categories, ensuring users can quickly identify and access content that aligns with their interests. This feature streamlines content discovery and enables users to explore specific domains more efficiently.

Article Summarization

Recognizing the need for concise and digestible information, ArticleInsightGuide offers a powerful summarization feature. By leveraging cutting-edge language models, the application generates comprehensive yet succinct summaries of articles, allowing users to quickly grasp the main ideas and key points without having to read through lengthy content.

Tag Generation

Effective tagging is crucial for enhancing discoverability and organizing content. ArticleInsightGuide's tag generation feature uses advanced NLP techniques to automatically generate relevant tags for articles, ensuring that users can easily find and navigate related content based on their interests.

Sentiment Analysis

Understanding the sentiment behind comments and feedback is essential for gauging public opinion and sentiment towards a particular topic or article. ArticleInsightGuide's sentiment analysis feature leverages advanced machine learning models to analyze comments and determine the overall sentiment, providing users with valuable insights into how their content is being received.

Question Answering

ArticleInsightGuide's question answering feature empowers users to obtain precise and contextual answers to their questions about an article's content. By leveraging deep learning models trained on vast knowledge bases, the application can provide accurate and relevant responses, enhancing the user's understanding of the subject matter.

With the interactive guided tour as the central focus, ArticleInsightGuide aims to provide users with a comprehensive and user-friendly experience, guiding them through the application's powerful features and empowering them to extract meaningful insights from written content effortlessly.

Supported Platforms

Initially, ArticleInsightGuide supports articles from two popular platforms: Dev.to and Medium. Users can simply provide the URL of an article from either of these platforms, and ArticleInsightGuide will process the content, generating insightful analyses and summaries.

Getting Started

ArticleInsightGuide offers a user-friendly interface that allows users to easily input article URLs and access the various features provided by the application. With its powerful AI-driven capabilities and the added benefit of an interactive guided tour, ArticleInsightGuide aims to revolutionize the way users consume and engage with written content, empowering them to make informed decisions and gain deeper insights effortlessly.

Demo

demo.mp4

Dependencies

  • React
  • Uvicorn
  • Yarn
  • FastAPI
  • Python
  • Shepherd.js

Installation

Clone the Repository

git clone https://github.com/rajesh-adk-137/ArticleInsightGuide.git

Frontend Setup

Navigate to the frontend directory:

cd ArticleInsightGuide/frontend

Install dependencies:

yarn install

Start the development server:

yarn run dev

Backend Setup

Navigate to the backend directory:

cd ../backend

Set up a virtual environment (recommended):

python -m venv env
source env/bin/activate  # On Windows use `env\Scripts\activate`

Install dependencies:

pip install -r requirements.txt

Note: The initial setup might take some time as it involves downloading several models.

Start the API server:

uvicorn api_article:app --reload

Usage

Visit the frontend application:

Open your browser and navigate to http://localhost:5173.

Make sure the backend is running at:

http://localhost:8000.

Screenshots

Landing Page: landing Home Page: home ArticleSummary: article

About Section: about

Contributing

We welcome contributions from the community! If you'd like to contribute to ShepherdInsight, please follow these steps:

  1. Fork the Repository: Click the "Fork" button on GitHub to create your copy.

  2. Clone Your Fork:

    git clone https://github.com/rajesh-adk-137/ArticleInsightGuide.git
  3. Create a Branch:

    git checkout -b your-branch-name
  4. Make Changes: Implement your changes.

  5. Commit Your Changes:

    git commit -m "Description of your changes"
  6. Push Your Changes:

    git push -u origin your-branch-name
  7. Create a Pull Request: Submit your changes for review.

License

This project is licensed under the MIT License.

Acknowledgments

  • Shepherd.js for the interactive guided tour library
  • React for the amazing JavaScript library
  • Yarn for the reliable package manager
  • FastAPI for the fast and efficient web framework
  • Python for the versatile programming language