xatter / rateitall

Mr. Rate It All browser extension

Mr. Rate It All

This project was bootstrapped with Create React App.

What?

Mr. Rate It All is a chrome/firefox extension that allows you to rate anything you can select on a webpage. Specifically I made this so I could rate individual dishes on online ordering sites such as Grubhub. Because, if we're honest, the idea that "this is a good place" is insufficient. They're really only good at a handful of the items on their menu, and I want to remember:

• What item's I've already tried
• Which ones were good or not so good
• Want to be able to rate things without affecting their overall rating in the system just because I disagreed or had a bad experience with a particular dish

As such all the ratings are kept locally on your browser and never transmitted anywhere else for "sharing" or spying of any kind.

Build and develop locally

This extension is written in TypeScript and React (because it's what I know). Thus it needs to be compiled into javascript in order to work.

git pull https://github.com/xatter/rateitall
cd rateitall
npm build

Once built, you can do

On Firefox:

about:debugging#/runtime/this-firefox

Click Load Temporary Add-on Navigate to rateitall/build/static/manifest.json

On Chrome:

...

Available Scripts

In the project directory, you can run:

npm build

This builds the typescript and puts the compiled extension into build/static so it can be loaded in the browser for debugging. Currently only "production builds" are supported (minimized JS which is difficult to debug.)

npm test

When there are tests this will run them.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

rateitall's Issues

Ratings don't appear or update until page refreshed

Currently after you've set a rating, you need to refresh the page in order for it to load. It should run the same DOM manipulation as it does when loading once you've created or updated a rating avoiding the need to reload

Ratings are overly sensitive to exact URL

There are elements of a URL that don't matter like jump tags like https://foo.com/my-article#heading the #heading part just tells the browser to jump to that section of the document, but the root URL is https://foo.com/my-article and is the only part that should matter when saving or retrieving ratings.

I need to see if there is the concept of a "core url" or a "root url" that has the important bits stripped of the ephemeral bits to use when saving ratings

Ratings in popup are not stars

Currently the Ratings are little circles instead of Stars. Not sure why, they should be stars

Ratings don't work on X website

Different websites update and manipulate the DOM in different ways from static on load, to advanced post-load manipulations in JQuery or React or whatever.

I think in order to solve this, and to get good ratings placement on all websites I'll have to create a "rendering strategy" object per-website that can override the DOM insertion logic of the ratings. It's a pretty straight forward design pattern, but I want to understand better why each website isn't working so I can see if there are more general patterns.

A pure css solution might be more stable overall (absolute offset from an element)