THIS PROJECT IS ARCHIVED. IT IS NOT UNDER ACTIVE DEVELOPMENT. FEEL FREE TO FORK IT!
Seer is an open-source dashboard to help you manage your GitHub organization's public repositories. The dashboard uses the GitHub API to retrieve all open issues and pull requests for your organization's public repos. It assigns each repo a color depending on how "fresh" it is; that is, how many open issues and pull requests are there and how long has it been since they have been updated.
Seer can give you a good idea of what repos are becoming unmaintainable within your organization. It also lets you assign a primary and secondary owner to your repos so everyone knows who is responsible for what. Seer will help you get a high level view of your repos and give them the love they need.
Check out Firebase Seer to see the dashboard in action for the Firebase organization.
There are two ways to view your own organization's dashboard. First, you could just tack on
?org=<your-organization>
to the Firebase Seer URL. For example,
here is the link to Facebook Seer.
You can also host your own version of Seer for your organization by cloning this repo. All you need
to do is replace the default organization username and public (no permissions) GitHub access token
in reposContainer.js
on this line
with your organization's username and your public GitHub access token.
If you need a place to host your organization's Seer, check out Firebase Hosting. You'll have your custom Seer up and running in just a couple minutes.
Only people who belong to your organization can view and edit ownership data about your repos. Unlike the repo data (i.e. open issues, pull requests, etc.) which is all public, ownership data is stored securely in Firebase and only visible to your coworkers. In addition, you can only assign ownership of a repo to someone if they belong to your organization.
If you'd like to contribute to Seer, you'll need to run the following commands to get your environment set up:
$ git clone https://github.com/jwngr/seer.git
$ cd seer # go to the seer directory
$ npm install -g gulp # globally install gulp task runner
$ npm install -g bower # globally install Bower package manager
$ npm install # install local npm build dependencies
$ bower install # install local JavaScript dependencies
$ gulp # build the distribution files
gulp watch
will watch for changes in the /src/
directory and compile, lint, concatenate, minify,
and copy the source files when a change occurs. The output files are written to the /dist/
directory.
To view Seer locally, you can use Python to spin up a local server:
$ python -m SimpleHTTPServer
Then, navigate to http://localhost:8000/dist/index.html to view Seer.