Skip to content

ugtkbtk/hackerweb

 
 

Repository files navigation

HackerWeb

A simply readable Hacker News web app. http://hackerwebapp.com/

About

This project started as one of my silly mini-projects. I create this initially to try out iOS 5+ Mobile Safari's new -webkit-overflow-scrolling: touch CSS support. I need some sort of content for scrolling, so why not Hacker News' stories? I'm also trying something called Fake it 'til you make it which I make the web app looks (and feels) like a native mobile app. In this case, like a native iOS app. If the web app is loaded on non-iOS devices, it'll switch to the 'web' theme which is like a generic theme for other browsers and platforms.

Read my two-part blog post on how I built this web app:

Also read my introductory post, Introducing HackerWeb.

Technical stuff

This web app works best on iOS 5+ Mobile Safari (iOS theme) and other modern browsers (web theme). It uses these wonderful scripts:

  • Hogan.js - logic-less templating
  • Amplify.Store - client-side storage
  • ruto.js - location.hash router
  • iOS
  • Web
    • ibento.js - simple event delegation
    • classList.js - shim for element.classList
  • Vanilla JavaScript - everything else

Also uses the unofficial Hacker News API.

Some of the cutting-edge web technologies used:

Development stuff

  • Prerequisites

      git clone git://github.com/cheeaun/hackerweb.git
      cd hackerweb/
      npm install
    
  • Grunt tasks

    • Compile templates in templates/* to generate assets/js/templates.js

        grunt templates
      
    • Concat and minify JavaScript files in assets/js/* to generate js/*

        grunt uglify
      
    • Watch the templates and scripts, run templates and uglify tasks when they're changed

        grunt watch
      
    • Embed images into CSS files

        grunt embedImages
      

      This will parse CSS files in assets/css/* and change this (any lines with url()):

        background-image: url(PATH); /* embedImages:url(PATH) */
      

      ... into this:

        background-image: url(data:DATAURI); /* embedImages:url(PATH) */
      
    • Run a local dev server.

        grunt connect
      

      Arguments:

      • --appcache - enable Application Cache
      • --port=XX - specify a custom port number
    • Run both watch and connect tasks at the same time

        grunt server
      

Contributing and Feedback

Feel free to fork, file some issues or tweet your feedback to me.

Do check out these awesome contributions as well:

Other platforms?

I have plans to make this app look native on other mobile platforms once I fork our some money and get my hands on other mobile devices (Android, Windows Phone, etc) for development and testing. Contact me if you feel generous enough to donate some devices to me :)

License

Licensed under the MIT License.

Other similar apps

This is the not the first third-party app for Hacker News. Others have tried doing the same thing, despite some slight differences. I've compiled a list of apps here.

About

A simply readable Hacker News web app

Resources

Stars

Watchers

Forks

Packages

No packages published