Beamanator / RIPS-Duplicate-Merger-CExt

RIPS duplicate client merger - Chrome Extension
0 stars 2 forks source link

Fixing chrome extension: making it dynamic #9

Open AliyahHA opened 1 year ago

AliyahHA commented 1 year ago

Problem

Other users unable to use Chrome merger extension because developers hard-coded it.

Why is this important?

Solution

Aiming to make chrome extension work by changing reference to StARS in RIPS URL link.

Implementation Steps

Two main steps: 1) Working in making RIPS merger chrome extension work locally.

2) Working in making RIPS merger chrome extension work through google extension store so it is easily accessible for everyone.

Beamanator commented 1 year ago

Perfect @AliyahHA 👍 One note: We want to make the chrome extension work... For a certain organization (I always forget which) so if I were you I would mention that in your steps to be super specific 👍

Beamanator commented 1 year ago

Useful link to learn about content scripts, in the chrome extension manifest.json file: https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Beamanator commented 1 year ago

Challenge for @AliyahHA : Get the extension running locally and make sure all of the steps work and are clear

  1. Follow these steps:
  2. Write down all of the difficult things you ran into. Try to solve them using google or friends.
  3. If there is anything you haven't figured out, we will solve them together
  4. At the end, we'll update the instructions to be as clear as possible
AliyahHA commented 1 year ago

Hi @Beamanator I got the extension running locally following the steps on Getting Started section:( https://github.com/Beamanator/RIPS-Duplicate-Merger-CExt )

  1. Difficulties faced: in the Getting Started notes section it did not specify that I need to actually clone the repo and create a folder in my desktop. This got me thinking a bit and I had to check and figure it out.
Beamanator commented 1 year ago

Nice @AliyahHA ! Good point about that, let's update the documentation to explain those steps! Can you try to come up with clear steps, then we can add that to the documentation?

Beamanator commented 1 year ago

So here's some things I think we can add to the README to make it better:

  1. A "table of contents" section with links to sections below (like this: https://github.com/expensify/App#table-of-contents)
  2. In the Getting Started section, add some instruction about cloning the repo onto your computer, something like this:
  1. Download the code from this repository on your computer by clicking the "Code" -> "Download ZIP" buttons at the top of the page Screenshot 2023-02-13 at 10 26 27 PM
  2. Extract the folder from the ZIP file
    • On Windows, right click on the ZIP file, then click "Extract"
    • On MacOS, just double-click the file
      1. In your terminal, change directory to the file you just downloaded
      2. Run npm install to install the node packages in the package.json file
      3. ... (continue existing steps)