In its current state, gobservatory is useful for creating an awesome list formatted markdown file containing all of your starred GitHub repositories and optionally organizing them using custom tags in addition to categorization by language.

Problem:

I have too many starred repositories, need a way to organize them with tags and comments.

Solution:

1. Sync the starred repository information into Ponzu using the GitHub API.
2. Add tags for categorization and additional comments.
3. Extract to an awesome list formatted markdown file.
4. Or consume the enriched content from Ponzu into a web client.

Important: This project requires Go 1.8 or higher.

Components:

gobservatory-cms

This is the Ponzu server to store and manage the starred repository records. Tags and comments should be edited here.

go get github.com/ponzu-cms/ponzu/...
go get github.com/kkeuning/gobservatory/...
cd $GOPATH/src/github.com/kkeuning/gobservatory/gobservatory-cms
ponzu build
ponzu run

cmd/gobservatory

Currently just a command line app to load any GitHub starred repositories into Ponzu for an individual GitHub account or extract a markdown file.

Usage

Loading and/or updating your CMS:

By default, gobservatory will load starred repositories from the logged in github account (cli will prompt for login), but optionally you can specify the "stargazer" of interest. It should be possible to aggregate starred repository lists for multiple users by running the cli against each stargazer's name and loading to a common Ponzu. The cli supports both initial creation and update of content in Ponzu.

cd $GOPATH/src/github.com/kkeuning/gobservatory/cmd/gobservatory
go build
./gobservatory load --ponzuSecret="[redacted]" --ponzuUser="yourname@example.com"

To update Ponzu requires authentication. If you provide no authentication, gobservatory will just prompt you to log into Ponzu. Alternately, you can provide a secret or token.

Replace "[redacted]" in the above with the "Client Secret" from Ponzu (e.g. http://localhost:8080/admin/configure from a logged in session). This method works if you are running the gobservatory cli and gobservatory-cms on the same server.

Accessing a remote server:

The easiest way to access a remote server is to omit authentication from the command line, letting gobservatory prompt you to log in.

./gobservatory load --ponzuHost="ponzu.example.com" --ponzuPort="8080"

Managing your content:

Use the Ponzu interface (e.g. http://localhost:8080/admin/contents?type=Star) to manage your content prior to publishing, adding tags or comments to your database of starred repositories.

GitHub will continue to be your authoritative data source, and updates or additions to your starred repositories in GitHub will be pulled into gobservatory on your next update, potentially overwriting your changes with some exceptions:

1. GitHub doesn't support tags or comments for starred repositories, so your tags and comments won't be overwritten when you update from GitHub.
2. If you "Unstar" a repository in GitHub, you will need to delete it manually from gobservatory at this point in time.
3. If you want to correct/alter the primary programming language associated with a project, use the Corrected Language field instead of Language. Corrected Language overrides the language identified by GitHub as primary for the project. If GitHub was wrong you can make corrections that will not be overwritten.
4. Current behavior for comments is to use the Description from GitHub as the default comment for a repository. Custom comments override description only if the Comments field is populated.

Building your "awesome" markdown file:

./gobservatory markdown

Since creating the markdown is a read operation, authentication using ponzuToken or ponzuSecret is not required.

The gobservatory cli will to extract starred repositories from the cms and organize them into a markdown file categorized by language. To also organize by tag, add the "useTags" flag:

./gobservatory markdown --ponzuHost="localhost" --ponzuPort="8080" --useTags