https://github.com/TerenceGrover/HSTW

Sentiment analysis tool aggregating world news, generating indices and displaying it all on a 3D globe.
https://github.com/TerenceGrover/HSTW

data-visualization data-viz data-vizualisation flask news newsapi python react

Last synced: 3 months ago
JSON representation

Sentiment analysis tool aggregating world news, generating indices and displaying it all on a 3D globe.

• Host: GitHub
• URL: https://github.com/TerenceGrover/HSTW
• Owner: TerenceGrover
• License: gpl-3.0
• Created: 2023-01-11T19:18:59.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-16T07:09:16.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T16:39:38.148Z (6 months ago)
• Topics: data-visualization, data-viz, data-vizualisation, flask, news, newsapi, python, react
• Language: JavaScript
• Homepage: https://hstw.io
• Size: 1.39 MB
• Stars: 19
• Watchers: 3
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
#  

#  🌍 How's The World 🌍 

A sentiment analysis tool that aggregates news sources from around the world to generate a happiness index. This project aims at facilitating news consumption and to have a concentrate of all important news within a single glance. The project is built using a combination of Python Flask for the backend and React for the frontend. 

![Screenshot 2023-01-16 at 20 31 03](https://user-images.githubusercontent.com/109336882/212753573-1db2d1b8-4a6e-41a3-b766-e0aa1e4eb7c2.png)

## Features

- Generates a happiness index based on the sentiment analysis of news headlines

- Visualizes the data on an easy-to-use dashboard

- Automated data collection process using web scraping techniques

- Responsive design, can be accessed on any mobile device

## Technologies

- Backend: Python Flask, pandas, nltk, boto3, feedparser

- Frontend: React, react-router-dom, react-globe.gl, CSS, Chart.js

## Installation

- Clone the repository

### For Backend

- I recommend the usage of a virtual environment

- Install the dependencies using `pip install -r requirements.txt`

- You might have to install nltk additional dependencies manually with 'python -m nltk.downloader all'

### For the Frontend

- Run the backend server using `flask run`

- Install the dependencies using `npm i`

- Run the frontend using `npm start`

## Usage

- Access the frontend at [hstw.io](https://hstw.io)

- Access the raw data at [hstwdrop.co](https://hstwdrop.co)

## Contributors Guide

- [ ] Reinforcement of the backend

- [ ] Updating the news sources

- [ ] Better impartiality in news source and fine-tuning of the scraping algorithm

- [ ] Development of the UI

- [ ] Addition of Chart.js visualisation

- [ ] Implementation of custom iPhone shortcuts for the visualization to be even faster and easier

- [ ] Instagram story generator for particular news that need extra-sharing

## Contributing

- I am currently the sole contributor, but I welcome any contributions and suggestions from the community to improve and expand the capabilities of this tool

- Please feel free to submit a pull request or open an issue

## License

- The project is not to be used for any commercial use wihout the prior agreement of the original Author

## Author

- [Terence Grover](https://github.com/TerenceGrover)

❤️