Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AKharytonchyk committed Mar 28, 2024
1 parent 0421646 commit 41babc9
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,26 @@

The GitHub PR Dashboard is a comprehensive tool designed to streamline the monitoring of pull requests across multiple repositories within the GitHub platform. Ideal for developers and teams managing multiple projects, it offers a unified view of PRs, facilitating better tracking and management.

## Demo Page

[Go to demo -->](https://akharytonchyk.github.io/git-pull-request-dashboard/)

## Features

- **Connect with GitHub**: Securely connect using GitHub Personal Access Tokens (PAT).
- **Organization and Repository Selection**: Choose which organizations and repositories you want to monitor within the dashboard.
- **Pull Request Overview**: Get a consolidated view of all pull requests across your selected repositories.

## UI Example

### PR Dashboard

![Dashboard](docs/images/dashboard.jpeg)

### Settings Overview

![Settings](docs/images/settings.jpeg)

## Getting Started

Follow these instructions to get your GitHub PR Dashboard up and running on your local machine for development and testing purposes.
Expand Down
Binary file added docs/images/dashboard.jpeg
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 docs/images/settings.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions src/service/gitService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,12 @@ export class GitService {
async getUserRepos() {
return this.octokit.paginate(this.octokit.repos.listForAuthenticatedUser, {per_page: 100, timeout: 5000, type: "owner"});
}

async getPRChecksStatus(owner: string, repo: string, prNumber: number) {
return this.octokit.checks.listForRef({owner, repo, ref: `pull/${prNumber}/head`, filter: "latest"});
}

async getPRApprovals(owner: string, repo: string, prNumber: number) {
return this.octokit.pulls.listReviews({owner, repo, pull_number: prNumber});
}
}

0 comments on commit 41babc9

Please sign in to comment.