Multiverse-of-Projects / NewsAI

A dynamic NewsAI dashboard that uses NLP to analyze news articles, visualize sentiment trends, and extract insights through interactive data visualizations.
https://news-ai-dashboard.streamlit.app/
GNU General Public License v3.0
18 stars 30 forks source link

Restructure the folder structure with the plan of scaling the application #42

Open vrajpatelll opened 1 month ago

vrajpatelll commented 1 month ago

Restructuring the Folder Structure for News AI Dashboard

The new folder structure aims to categorize files and directories more logically. Below is the proposed structure:

news_ai_dashboard/
│
├── src/
│   ├── ingestion/
│   │   ├── newsapi.py
│   │   ├── praw.py
│   │   ├── gnews.py
│   │   └── fetch_full_articles.py
│   │
│   ├── preprocessing/
│   │   ├── format_data.py
│   │   └── structure_data.py
│   │
│   ├── sentiment_analysis/
│   │   ├── sentiment_model.py
│   │   ├── classify.py
│   │   └── wordcloud.py
│   │
│   ├── summarization/
│   │   └── summarize.py
│   │
│   ├── api/
│   │   ├── __init__.py
│   │   ├── main.py
│   │   ├── endpoints/
│   │   │   ├── __init__.py
│   │   │   └── pipeline.py
│   │   ├── models/
│   │   │   ├── __init__.py
│   │   │   └── pipeline_model.py
│   │   ├── schemas/
│   │   │   ├── __init__.py
│   │   │   └── pipeline_schema.py
│   │   ├── services/
│   │   │   ├── __init__.py
│   │   │   └── pipeline_service.py
│   │   ├── db.py               # Database connection and utility functions
│   │   └── utils.py
│   │
│   └── dashboard/
│       ├── app.py
│       └── components/
│
├── notebooks/
│   └── sentiment_analysis.ipynb
│
├── requirements.txt
├── README.md
└── .gitignore

Objectives

  1. Enhance Organization: Group related scripts and modules to improve navigation and understanding of the project.
  2. Improve Scalability: Create a structure that can accommodate future growth without becoming cluttered.
  3. Facilitate Collaboration: Make it easier for team members to locate files and understand their purposes quickly.

Tasks

Spraveen8-chary commented 1 month ago

I'd like to contribute to this issue by restructuring the folder as proposed. I'll handle moving the files, updating import paths, testing functionality, and documenting the changes in the README. Let me know if you'd like me to proceed!