GitXplorerGitXplorer
j

github-issues-viewer

public
239 stars
19 forks
3 issues

Commits

List of commits on branch master.
Unverified
4769bfe5f812e4e1b3f1f9bf81b2b3e782d54be3

description of component hierarchy

jjaredly committed 11 years ago
Unverified
82dc5363a6bbad4ce58142427ce86b02f914caab

lots of documentation

jjaredly committed 11 years ago
Unverified
af4c54d73f6767f32ff1261779bab0fe8dfabf69

Merge branch 'master' of github.com:jaredly/github-issues-viewer

jjaredly committed 11 years ago
Unverified
5f2c7323634a72d7512ed14dfc4f6ceb21e5a3b1

readme up

jjaredly committed 11 years ago
Unverified
186357644247c6a857bb6ada7d861023ec55a088

gh-pages target

jjaredly committed 11 years ago
Unverified
1f5a20d5eb3436f0e41b822be621dd7d739c128a

more informative messages

jjaredly committed 11 years ago

README

The README file for this repository.

Github issues viewer

This is a viewer of github issues that is entirely client-side. It demonstrates one way of building a slightly-more-than-trivial app with facebook's React framework.

All requests to the github api are anonymous, so they cap it at 60 requests/hour.

View the live example.

Screenshot

Components

  • App fetches models
    • RepoInput
    • View manages routing
      • AllIssuesPage
        • Pager
        • Issue
      • IssuePage
        • RecentTime
        • Comments
          • Comment
            • RecentTime

Technologies used:

Known Issues

The Teaser

On the main page, the teaser of the issue body can break markdown sytax, resulting in awkward-looking ```some code here or **bold but not at the end of the teaser.

I thought about (and started implementing) an ad-hoc fix but then stopped, because it was dirtly and incomplete. The real solution would be to translate the raw text into a markdown syntax tree, and then grab the first x chunks from there. A project for another time. I couldn't find a lib on npm to do it, but if you know of one, please open an issue or pr.

Anonymous API usage cap

It might be interesting to look into auth w/ github...not sure if that's possible in a backend-less app.

Not yet implemented things

  • auto-linking to referenced issues
  • auto-linking to commits, comments, etc
  • probably a few other things

Building

npm install -g react-tools component less
make
google-chrome web/index.html

Hacking

npm install -g jshint mocha
make test

License

Apache v2

Contribution and Comments are welcome.