github-dashboard

Overview

GitHub Dashboard is a locally running web application that aims to help streamline the management of your GitHub repos and issues in one place. Browse all your repos (personal and subscribed), see open issues, see if any are assigned to you, and link directly to any repo. You can check out a full product overview here

To run, all that is required is the latest LTS version of Node installed and the package manager, Yarn. A GitHub access token will also need to be generated. The Setup section below will cover all of this.

Setup

After cloning the repo, and making sure you have Node LTS installed, please do the following

Install Yarn globally (>= 1.0)
Install dependencies
```
$ yarn install
```
Setup the application
```
$ yarn run setup
```
Log into your GitHub account and create an Personal Access Token with the following scopes:
- repo
- admin:org
- notifications
For information on creating an access token, please visit the GitHub article on creating access tokens
Open /src/services/credentials.ts and replace the xxx's with your GitHub username and a Personal Access Token

Note: The credentials.ts file is listed within the .gitignore to prevent accidental inclusion within the repository files.

For information on architecture and design of this application, checkout the Developer's Guide here

Starting the application

Once you've entered in your credentials, you can start the application:

$ yarn run serve

For more information on available tasks, check out the Developer's Guide.

Additional References

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.