Last week (or maybe a little bit longer ago), I came across an image of a marvel movie marathon and in what order you should watch the movies and TV series so you'd view them in a chronological order. To simplify things, I made the site marvelmoviemarathon.com. Just to be clear, let me reiterate: I'm not affiliated with Marvel in any way and if I'm in violation of certain copyright laws, contact me and we'll work something out.
But I wanted to document how I host it on github and which resources I use: bootstrap, a bootstrap timeline, jQuery and mustache.js. (You know, promotional material and documentation for posterity.)
The last step was to get a domain to serve pages from the github.io address. You go to the dashboard on your DNS host and create an ALIAS that points to .github.io. To let github know to which project you want a domain to redirect, you need to check in one more file to the "gh-pages" branch of your project. This file has to be named "CNAME" with the address of the site as the sole content (in this case "marvelmoviemarathon.com"). The capitalization is very important! If you don't use capital letters, github won't recognize it as the file that contains the domain.
The main point was to keep this site simple, so updating it with new content would be very easy. The reason I wanted to talk about hosting first is because you'd know I don't have a server side component or database that provides the data, it's just a data file in json format. So if I need to add or edit records, I only have to update one file and I'm done.
The first step is to load the data via an ajax call using the jQuery api (this also helps to keep the site quite responsive). When I have the data, I load two templates I build with mustache.js. Why two templates? One for the left and one for the right side of the timeline. Filling in the correct class won't change the position of the poster in the timeline. I wasn't planning on making those changes in code, it was a lot easier to create two templates. Sue me, I'm a lazy programmer.
The code of the timeline isn't entirely mine either. I found the basis on codepen, which had one slight problem: it didn't adjust nicely to mobile devices. A tablet will work decently, but when viewed on small mobile devices, it would keep the middle divider line. This would make the timeline items almost unreadable and (more important) very ugly. So I modified the css with a media query that will place the divider line to the left when the screen has a smaller width than 450px and place all the timeline items to the right. With the two different templates, the posters alternate between being displayed left and right, which keeps the visual flow from the timeline.
The most important part is to remember that hosting a small site on GitHub Pages is very easy and cheap with a pretty reliable uptime, but no guarantees. The rest of the article is just to make me look important. :)