https://github.com/andyklimczak/andystreambrowser
https://github.com/andyklimczak/andystreambrowser
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andyklimczak/andystreambrowser
- Owner: andyklimczak
- Archived: true
- Created: 2014-05-06T17:38:50.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-05-29T15:09:03.000Z (about 11 years ago)
- Last Synced: 2024-10-29T03:05:39.055Z (7 months ago)
- Language: JavaScript
- Homepage: http://blooming-springs-7203.herokuapp.com/
- Size: 684 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
heroku link: http://blooming-springs-7203.herokuapp.com/
# readme
## why I made this
This website allows you to browse streams in a visual format, where streams are sorted by viewer, irregardless of game.
On the website, Twitch allows you to browse streams by game, where streams are sorted by viewer count. It also allows you to see all of the top streams by viewer for all games. But it does not allow you to filter top streams by game. So with this, you can filter out specific streams of a particular game that you don't want to see in the top streams. This is because some streams of particular games are always popular, and not seeing these streams might be preferred.
## [twitch kappa api](https://github.com/schmich/kappa)
I use the Twitch 'Kappa' rails api in order to access Twitch stream/channel information.
## authentication (devise)
Devise is used to handle authentication. I customized the model and added a ':games' attribute to store all the games that the user would like to filter out.
The games are presented in a multiselect element in the user registration/edit views. I initially tried using checkbox elements, but that would use too much screen space trying to present 100 games with associated checkboxes. Then I decided to use a simple text field, where each game would be entered by the user and seperated by a comma. This worked, but was not user friendly. Then I figured out how to use multiple select boxes.
## paging (will_paginate)
Pagination was rather straight forward to add. Page size is small to help with loading of the main page.
## user interface (bootstrap)
I've had some familiarity with bootstrap used for a past class project. I applied as many simple bootstrap 'tricks' as I could throughout the pages, but because the pages are so minimal, not much I could add.
Bootstrap specific things are: the header on all pages, the various buttons on pages, the rounded of the main div shown on each page, and the look of the form fields.
## unit tests (rspec)
I have two simple set of tests (spec/controllers/streams_controller_spec.rb & spec/models/user_spec.rb) that test the basic functionality of the pages and interactions.
# bugs
* ~~Main page loads really, really slow. I think it's because of the number of images though?~~ loads a bit faster now
# todo
* get the user's twitch username and have the user's subscriptions and following streams at the top. Twitch doesn't do anything like this on their homepage yet
* allow user to change the number of total streams, streams per page
* better tests