Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
OperaVaria authored Feb 26, 2024
1 parent b90af8a commit 2fa4aa0
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@

This is the source code for a simple web app that scrapes the internet for cute
animal pictures, and displays one at random upon user request.
Its mainly written in Python, utilising the Flask web framework.
It is mainly written in Python, utilising the Flask web framework.
The frontend component is a standard HTML-CCS-JS website, with a simple custom styling.

## Functionality

The webapp, in its current form, is set up to be hosted at [pythonanywhere.com](https://www.pythonanywhere.com/).
Scheduled background tasks (the scripts in ./scraping/) collect the top 30 "hot" posts from preset subreddits every night,
Scheduled background tasks (the scripts in ./scraping/) collect the top 30 "hot" posts from pre-set subreddits every night,
and store the information in pickle files (./data/). The raw data is then read when Flask assembles the requested HTML page,
and a random post is selected. The scraping scripts use the [PRAW module by Bryce Boe](https://github.com/praw-dev/praw).
and a random post is selected. The reddit scraping scripts use the [PRAW module by Bryce Boe](https://github.com/praw-dev/praw).

Server-side Flask sessions are utilised (via the Flask-Session extension) to avoid sending the same results to the same user.
Server-side Flask sessions are utilised (via the Flask-Session extension) to avoid sending the same results to the same user multiple times.

The HTML-CSS side has a responsive, Flexbox layout. It is optimized to display correctly on all
screen types.
The HTML-CSS side has a responsive, Flexbox layout. It is optimized to display correctly on all screen types.

## Screenshots

Expand Down

0 comments on commit 2fa4aa0

Please sign in to comment.