Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/superskyyy/stackoverseer

This is a StackOverflow monitor where you can easily access the most trending and up-to-date questions on a particular set of tags. This project can be modified to support wider range of tags and provide functionalities.
https://github.com/superskyyy/stackoverseer

charts data-visualization stackoverflow-api stackoverflow-questions

Last synced: about 7 hours ago
JSON representation

Host: GitHub
URL: https://github.com/superskyyy/stackoverseer
Owner: Superskyyy
License: mit
Created: 2020-08-12T18:46:43.000Z (about 4 years ago)
Default Branch: dev
Last Pushed: 2020-08-14T18:20:24.000Z (about 4 years ago)
Last Synced: 2024-10-16T20:34:13.242Z (22 days ago)
Topics: charts, data-visualization, stackoverflow-api, stackoverflow-questions
Language: CSS
Homepage:
Size: 824 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# StackOverseer

#### See the titles of the 10 newest User-defined-related questions and the 10 most voted in the past week.

!["core"](https://github.com/Superskyyy/StackOverseer/blob/dev/preview_monitor.png
)
## Core Feature:

- On the left sidebar, a tools section gives the entrance to two pages.
- Each serves a real-time monitored page on 10 latest or 10 trending Questions on "#Android".

- By clicking on the buttons/ interactive UI, a user can
1. Navigate to original Question page via new tab.
2. Preview Question & Answer threads by clicking on the listed question.
3. See the Votes & Answer count in a straightforward UI.

- StackOverflow disallows accessing any answer-related-content via iFrames or API.
Parsing the RSS feed became the next best option.

- These pages can be stacked or modified to take user inputs on monitoring different tags/filters with few changes.

## Limitations

Features like voting are not implemented as it requires complex auth process.
UI components are in place though.

## Bonus Features:
- Following two features doesn't use real-time scraping due to API limits and costs.
Few minor modifications will allow more frequent runs.

- Almost responsive design.. smartphone compatible.

!["heatmap"](https://github.com/Superskyyy/StackOverseer/blob/dev/preview_heatmap.png)
- Data visualization of "User heatmap who asked a Android related question over the past week"
- This feature is implemented using Leaflet.js

!["wordcloud"](https://github.com/Superskyyy/StackOverseer/blob/dev/preview_wordcloud.png)

- Data visualization of "Technologies most related to Android over the past week"
- This feature is implemented using wordcloud2.js and a Geocoder API.

## Built With

### Technologies
* [Django](https://www.djangoproject.com/) - The web framework for perfectionists with deadlines.
* [jQuery](https://github.com/jquery/jquery) - jQuery JavaScript Library.
* [Bootstrap](https://github.com/twbs/bootstrap) - The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web.
* [Font-Awesome](https://github.com/FortAwesome/Font-Awesome) - The iconic SVG, font, and CSS toolkit.
* [Leaflet](https://github.com/Leaflet/Leaflet) - JavaScript library for mobile-friendly interactive maps.
* [wordcloud2.js](https://github.com/search?q=wordcloud2) - Tag cloud/Wordle presentation on 2D canvas or HTML.
* [Feedparser](https://github.com/kurtmckee/feedparser) - Parse feeds in Python.
* [Docker](https://www.docker.com/) - Docker Engine.
* [Gunicorn](https://pypi.org/project/gunicorn/) - Python Http Server.

### Services

* [Tom Tom](https://developer.tomtom.com/) - A Geocoder API Service.
* [StackExchange API](https://api.stackexchange.com/) - StackExchange API

## TO DO LIST:

- Cleanup code
- Better Responsive Design

### Deploy

Docker - Gunicorn - Tencent Cloud

## This project is Dockerized
#### Configurations
1. Modify settings.py in StackOverseer, make sure docker is set to `True`

- To run the project in pure local env (Not recommended).

- To build the source code in your local Docker
- The docker container will automatically reflect latest change of source code.
So don't build again, run ```> docker-compose up ``` instead.

1. Clone the code, make sure docker is running
2. Make sure the DOCKER Variable is set to True in settings.py
3. Run following commands
```bash

[Windows Git Bash]> winpty docker-compose run web python manage.py createsuperuser

[Unix & Powershell]> docker-compose run web python manage.py createsuperuser

docker-compose build

docker-compose up

```

### PyLint
- Pycharm - Preference - Plugin - Marketplace

- Search for Pylint, Install it and reboot Pycharm.
Pylint will appear as an icon in lower left corner, there's one inside VCS - Commit too.

## Requirements

* [Python 3.7+](https://www.python.org/)
* `python` on the PATH

#### Python path can be found by

```
import sys

print("Python EXE : " + sys.executable)
```