https://github.com/jaredly/github-issues-viewer
A gitub issues viewer build in react + backbone
https://github.com/jaredly/github-issues-viewer
Last synced: 3 months ago
JSON representation
A gitub issues viewer build in react + backbone
- Host: GitHub
- URL: https://github.com/jaredly/github-issues-viewer
- Owner: jaredly
- Created: 2014-01-04T22:35:03.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-01-05T05:03:13.000Z (over 12 years ago)
- Last Synced: 2025-09-28T21:33:54.925Z (9 months ago)
- Language: JavaScript
- Homepage: http://jaredly.github.io/github-issues-viewer/
- Size: 1.23 MB
- Stars: 238
- Watchers: 10
- Forks: 18
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
# 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](http://facebook.github.io/react).
All requests to the github api are anonymous, so they cap it at 60
requests/hour.
[View the live example.](http://jaredly.github.io/github-issues-viewer)
[](http://jaredly.github.io/github-issues-viewer)
# Components
- App *fetches models*
- RepoInput
- View *manages routing*
- AllIssuesPage
- Pager
- Issue
- IssuePage
- RecentTime
- Comments
- Comment
- RecentTime
Technologies used:
- [React](http://facebook.github.io/react) for the views
- [Backbone](http://backbonejs.org) (mostly for routing... no mutable models here)
- [Bootstrap](http://twbs.github.io/bootstrap) for some styling
- [Component(1)](http://github.com/component/component) for packaging
- [LessCSS](http://lesscss.org) for css processing
- [FontAwesome](http://fontawesome.io) for icons
## 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.