├── .dockerignore ├── .gitignore ├── Dockerfile ├── bower.json ├── LICENSE ├── index.html ├── frank-ly.html ├── README.md ├── frankly-header.html └── frankly-results.html /.dockerignore: -------------------------------------------------------------------------------- 1 | .dockerignore 2 | Dockerfile 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | bower_components 3 | deploy 4 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM fedora:23 2 | 3 | # Install npm 4 | RUN dnf -yq install npm 5 | 6 | # Set up the working directory and pull in everything in the local directory 7 | # This assumes you build the docker image in the git repo directory 8 | WORKDIR /frankly 9 | ADD . /frankly 10 | 11 | # Install bower and then install frankly 12 | # Work around: everything in this container runs as root 13 | RUN npm install -g bower 14 | RUN bower install --allow-root 15 | 16 | # Expose the port and run the web server 17 | EXPOSE 8000 18 | CMD ["python", "-m", "SimpleHTTPServer"] 19 | -------------------------------------------------------------------------------- /bower.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "frankly", 3 | "version": "1.0.0", 4 | "description": "A summary dashboard about the issues/PRs for a set of GitHub repositories", 5 | "authors": [ 6 | "Monica Dinculescu " 7 | ], 8 | "keywords": [ 9 | "web-components", 10 | "polymer", 11 | "dashboard", 12 | "issues", 13 | "github", 14 | "firebase" 15 | ], 16 | "repository": { 17 | "type": "git", 18 | "url": "git://github.com/notwaldorf/frankly" 19 | }, 20 | "main": "frank-ly.html", 21 | "dependencies": { 22 | "polymer": "polymer/polymer#^1.2.0", 23 | "font-roboto": "polymerelements/font-roboto#^1.0.0", 24 | "firebase-element": "googlewebcomponents/firebase-element#^1.0.0", 25 | "paper-button": "polymerelements/paper-button#^1.0.0", 26 | "paper-toolbar": "polymerelements/paper-toolbar#^1.0.0", 27 | "paper-styles": "polymerelements/paper-styles#^1.0.0", 28 | "webcomponentsjs": "webcomponents/webcomponentsjs#^0.7.0" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2016 Monica Dinculescu 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Issues 8 | 9 | 10 | 11 | 12 | 29 | 30 | 31 | 32 | 34 | 35 | 36 | 37 | 42 | 43 |
44 |

made with ❤︎ by 45 | monica. 46 | find this on github

47 |
48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /frank-ly.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 29 | 30 | 90 | 91 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # frankly 2 | `Frankly` is a summary dashboard about the open issues and PRs across any set of GitHub repositories. 3 | Because, frankly, we need one. 4 | 5 | ## Installing and running the demo 6 | 7 | ``` 8 | git clone https://github.com/notwaldorf/frankly.git 9 | cd frankly 10 | bower install 11 | python -m SimpleHTTPServer ## or your favourite local server 12 | ``` 13 | 14 | ## Sample use 15 | 16 | This is what the `index.html` contains 17 | ```html 18 | 19 | 20 | 21 | 22 | 23 | 27 | 28 | ``` 29 | And that's literally it. It looks like this: 30 | 31 | screenshot of the dashboard 32 | 33 | ## Configuring it 34 | 35 | By default, the dashboard looks at the repositories under the authenticated 36 | user's username, however it can be configured to use an organization, or even 37 | a mix of repositories from different users and organizations: 38 | 39 | ### All the repositories the user is subscribed to 40 | 41 | ```html 42 | 44 | 45 | ``` 46 | 47 | ### Repositories for a specific organization 48 | 49 | ```html 50 | 54 | 55 | ``` 56 | 57 | ### Repositories for a mix of users and organization 58 | 59 | ```html 60 | 64 | 65 | ``` 66 | 67 | You can also configure which labels you want to display. `Untriaged` 68 | is always the open issues that have no labels applied to them. 69 | 70 | ## Multiple dashboards in parallel 71 | 72 | To use multiple dashboards for the same user, just use the `` 73 | element directly, with multiple `` elements. A `dom-bind` is a 74 | special Polymer construct that allows you to easily bind data together (in this 75 | case, the authenticated user: 76 | 77 | ```html 78 | 79 | 80 | 81 | 82 | 83 | 99 | ``` 100 | 101 | ## Private repos? 102 | At the moment `Frankly` only works for public repos, since it's requesting 103 | the least amount of permissions from GitHub -- my understanding is that 104 | the permissions needed to access anything about private repos require 105 | read/write access to _all of_ that organization's repos, which is a bit scary. 106 | 107 | ## Deploying it somewhere? 108 | `Frankly` uses Firebase to authenticate to GitHub. The Firebase app that I've included 109 | lets you run the app locally, but won't work once you deploy it to your 110 | own domain. In that case, all you have to do is create your own Firebase 111 | and GitHub apps (make sure to update your GitHub secrets into the Firebase app) 112 | and update the Firebase settings in `frankly-header`: 113 | ```html 114 | 117 | 118 | ``` 119 | 120 | ## <3 121 | Hope this helps you stay on top of issues and PRs! 122 | -------------------------------------------------------------------------------- /frankly-header.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 96 | 97 | 135 | 136 | -------------------------------------------------------------------------------- /frankly-results.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 168 | 169 | 459 | 460 | --------------------------------------------------------------------------------