sbuergers/sustainable-recipe-recommender-website

Flask web-app for recommending sustainable recipes to users.

sustainable-recipe-recommender-website's Issues

Make sure Google finds the website

Check Meta-tags?

Remove hard-coded hyperlinks

Add context to how much 1kg CO2 eq actually is

Is your feature request related to a problem? Please describe.
People might be interested to put the carbon emission scores of recipes into context: E.g. related to their car or home electricity use.

Describe the solution you'd like
We can add some info links for this and refer to this website: https://www.epa.gov/energy/greenhouse-gases-equivalencies-calculator-calculations-and-references, as well as add some summary descriptive statistics to our site - e.g. how much CO2 eq the average car emits per day or the average home emits in utilities.

Sign in automatically after sign up

It's annoying to have to sign in after just creating an account.

I want users to be logged in automatically after signing up.

Security headers in development

When developing (debugging and testing) I use HTTP, not HTTPS, which is used in production.

An enhancement would be to enable HTTPS also in development. mkcert can be used for this presumably.

This is not super urgent right now though, because I created the staging environment on Heroku.

Allow for more advanced search filters

For instance, only search for vegan / vegetarian / pescetarian / paleo ...

It could also be great to allow for selecting certain ingredients, or conversely prohibiting certain ingredients (e.g. due to allergies).

All of these things could be accessed through a "filter" button / link on the home page, or in the navbar next to the search.
Once personal profiles are available, it should be possible to save personal preferences (e.g. allergies / vegan ...). So they do not need to be specified anew everytime.

Integrate new user's ratings with epicurious data

Find a way to continuously integrate new ratings with the existing epicurious dataset.

Incorporate unit tests, integration tests etc.

The codebase needs some tests we can run to assess whether a new add-on (or indeed as it stands now) breaks it's functionality.

Worked on here:
https://github.com/sbuergers/sustainable-recipe-recommender-website/tree/continuous_integration

Tests could be grouped as follows:

• Database tests (each query gives me what I want? Is it converted correctly and displayed to the user? What happens when the connection fails?)
• Website functionality tests (use Selenium to simulate users' behaviour. Sign up for account - behaviour as expected? Login, click through etc.) For this it will be useful to simply watch it go through everything and see what happens.

Add footer

A good website needs a footer!

Include my contact info + logo for now.

Limit number of password resets to three per day

If we do not do this, people could theoretically harrass others by sending them endless emails from SSR. I suppose if they can do that they could also spam them in a myriad of other ways, but then at least it does not drag SSR into it.

Low priority though for now.

Add email confirmation request

Useful resource: https://realpython.com/handling-email-confirmation-in-flask/#flask-basic-registration

Use `black` formatting throughout the repo

Using a general code formatting framework makes things easier. ideally we should also add a bot that automatically updated any incoming PRs by running python3 -m black {source_file_or_directory} on it.

Add "forgot password" feature to login page

Required email confirmation to be implemented first.
--> Only confirmed accounts can request password or account reminders (this issue: #26 (comment)).

Is your feature request related to a problem? Please describe.
At the moment, when users forget their password or username, they cannot ask to retrieve it via email.

Describe the solution you'd like
Include a "forgot password" and "forgot username" link to login page. They will be sent their password or username to their email address.

Describe alternatives you've considered
NA

Additional context
NA

Make sure app is secure

Check for vulnerability to the following (see here for more information):

1. SQL injection attacks

2. Cross site scripting

3. Cross site request forgery

4. Man in the middle attacks (check security headers)

Improve free search

Right now the free search only uses LIKE %search_term% and edit distance (aka Levenshtein distance) to sort the search results. The search is implemented in fuzzy_search in sql_queries.py. This should be improved. Postgres has pretty advanced full text search features, which should come in handy.

Disable automatic liking of recipes when bookmarking

Describe the bug
When bookmarking a recipe it is automatically highlighted as liked at the same time on results.html (from compare_recipes route). Interestingly, this does not happen for profile.html and explore.html.

To Reproduce
On results.html click on a bookmark icon of an unbookmarked and unliked recipe.

Expected behavior
Recipe gets highlighted as bookmarked, but not as liked.

Create cookbook

It is possible for users to create an account and login. But there is no functionality that makes this useful.

The Cookbook link should refer users to their personal cookbook, which includes recipes that they liked / added to it. To make this work we need

• A like button or add to cookbook button next to a recipe.
• A DB for User's liked recipes (the cookbook)
• An HTML page to present the cookbook
• A Flask route for the cookbook

Once the cookbook functionality has been created. The next step would be to integrate collaborative filtering recommendations.

Change bindparams syntax in sql_queries.py

SQL queries in sql_queries.py make use of bindparams, which will be deprecated in future releases of SQLAlchemy. Change syntax appropriately.

The CSS styling of the navbar for the Blog link is mismatched

The CSS styling of the navbar for the Blog link is mismatched, because I exported the Jupyter notebook that is displayed as HTML, which includes all kinds of custom CSS. I might simply be able to solve this by exporting the notebook as pdf.

Add licence to repo

Since I cannot revoke a creative commons license, I will for now simply keep the copyright to myself.

Decouple User database from Heroku and add to AWS RDS

It's more convenient and less confusing when everything is in one place.

Support direct matching to recipe titles in recipe search

This is also described in the about page, which is now incorrect. They are only matched by recipe specific url.

That being said, if you search for the recipe title, the only recipe that is going to be found is the one that contains all the recipe words in the url - so this somewhat works already (though maybe not always). It also does not open the results.html page, but rather explore.html with a single result - the recipe of interest.

Refactor app structure

Following good practice with application factories, consider implementing a structure like suggested here.

Basically, do not lump too many things into app.py and modularize extensions.

I had a brief look at this and ran into problems with copying folders using the git comman line (permissions denied). A brief google offered no quick fix.

This is related to rewriting all psycopg2 queries as flask_sqlalchemy queries. It is still not clear to me though if I should use flask-sqlalchemy or simply sqlalchemy.

After deleting account redirection to main.home fails

Describe the bug
After deleting account redirection to main.home fails. Instead we stay on main.profile.

To Reproduce
Steps to reproduce the behavior:

1. Go to main.profile whilst logged in with account you are happy to delete
2. Click on delete account button after typing in your username
3. See that you are still on the main.profile route, not main.home

Expected behavior
After account deletion we should be redirected to main.home

Formatting of web-page falls apart after resizing browser window

Describe the bug
When I resize the browser image the emissions histogram on the profile page does not resize (which may be sort of ok), but it also starts overlapping with the text next to it.
Similarly, the options/links (recipe, suggestions, thumbs up ...) below recipe items in the cookbook do not rescale to fit the width of each recipe picture, which makes it look funny.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'cookbook'
2. Resize the browser window to be smaller than normal until formatting falls apart

Expected behavior

Emissions histogram should never overlap with text (either run out of screen or horizontally stack). Is it possible to resize the image depending on the browser width?

Links below recipe items should match the image in width whatever the browser window size

Screenshots

Desktop (please complete the following information):

• OS: [Windows 10, 19018.1198]
• Browser [Chrome 87.0.4280.66]
• Version [NA (I did not include github versioning yet)]

Smartphone (please complete the following information):

• Not tested on smarthpone

Additional context
NA

Improvements to search results interface

I believe the following would make interaction with the website more pleasant:

1. Allow clicking on recipe title or picture to select it as new reference recipe. The only link to epicurious should be what is now calles "visit recipe". This link should be renamed to "recipe on epicurious", where epicurious is a variable in order to make it possible to later extend to other recipe websites.

Change - to + in altair bar plot of carbon emissions

Thanks Sebastian Michelmann for pointing this out!

Allow users to unsubscribe from newsletter easily and delete their account altogether

Currently not clear how to do either.

Make sure they can easily set this on their profile page (add new links for it).