Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.9 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.9 KB

Github issue board

Github issue board is a dashboard where you can see all of your open issues on one sight. The application is still under heavy construction (a.k.a. early alpha) and may change drastically.

Usage

The application is hosted here and you can start using it straight away. The routing doesn't still work with full page refreshes on subroutes. The application doesn't record any of your personal GitHub data, but only uses minimal parts of it to show your issues. All data is stored on your browsers local storage.

Development

Requirements

  1. You need to register an application to your GitHub account. You can do it here.
  2. You need to set up a github-secret-keeper and follow the instructions provided in there.

Development

  1. git clone [email protected]:roopemerikukka/github-issue-board.git
  2. cd github-issue-board
  3. yarn
  4. Add the address of your github-secret-keeper app to package.json in here:
"github-issue-board": {
  "secret-keeper-url": "https://your-secrets-app.herokuapp.com"
}
  1. Configure the start script with your client IDs:
"start": "REACT_APP_DEV=<YOUR-CLIENT-ID> react-scripts start"

Screenshots

screenshot 2017-03-14 18 47 55

About the project

The Github issue board started as an university course project and kind of introduction for me to get a better understanding about GitHub API, Redux, testing ect. so the code might not be as efficient as it could be. I try to refactor it as I have time, but all pull requests and improvement suggestions are welcome!


Github issue board was bootstrapped with Create React App.