Application Usage
We expect users interesting in monitoring their favorite repositories to use this website. There is just the hosted website for the users which can be accessed here.
To use the app, these users should first create an account or login, which is accessible via a button at the top right of the screen on the landing page.
Once logged in via Google OAuth, users should see their home page of repositories. Our intended users should be able to access the repositories they wish to see and view their last week's summaries.
This is an example summary from the React repository:
Users will see a landing page when they first get onto the website.
There is not much to do here besides signing up or logging in. When clicking this button at the top right of the screen, users will see this modal:
A user should now sign in. If they sign in successfully with the Google OAuth service, they should see a new screen which displays all of the application's current repositories alongside their current subscribed repositories. This is what it will initially look like before subscribing to any repositories:
If a user wants to subscribe to a repository, they can do so by clicking the "Subscribe" button on a repository. This button is located in the middle of the element card:
Now, users should be able to see repositories that they subscribed to. For example, after subscribing to the MongoDB repository, the screen updates to show this:
This information is also updated in the backend to reflect the user's new subscribed to repositories, which will now be added to their next weekly email update.
Users can also view the summarized PRs of any of the listed repositories. For example, if they click on the "View" button for MongoDB, they will see this page:
This page contains a list of the summaries, the dates they occurred on, and the respective title. If a user scrolls through, they will see PRs in descending order!