Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Design page #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions dg/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,23 @@ views is constructed using data provided by **services**. In the following secti

## Views

<!-- Todo: fill the views -->
There are primarily only two views accessible by the user - the Issues Dashboard and the Activity Dashboard.

The diagram below shows how a user can navigate between the different views.

![](../images/views.png)

Each view is built out of components. As an example, the following diagram deconstructs the Issues Viewer component, which is the main component for the Issues Dashboard, to show how it is built using several smaller components. For instance, the `Card-viewComponent`, a child component of `IssuesViewerComponent`, is responsible for displaying PRs/issues of each user.

![](../images/components.png)

## Services

<!-- Todo: fill the services -->
Services are classes that define business logic or communicate with the app's backend (GitHub). For ease of understanding, we have distinct services for the different types of data exchanged with the backend. Below are some examples:

- `IssueService`: Responsible for fetching issues from GitHub.
- `AuthService`: Responsible for initiating the authentication process, and querying / updating application state related to authentication.
- `LabelService`: Responsible for retrieval and parsing of label data from GitHub repository for WATcher.

Under the hood, several services use the `GitHubService` to communicate with GitHub.
The `GitHubService` abstracts the details of communication with GitHub, away from the other services.
Binary file added images/components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/views.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.