Reading List

This repository contains my open source reading list. I keep track of books by editing the files here and the results are automatically published as a website at http://bamos.github.io/reading-list.

This repository just contains stubbed examples of how to use this project. Ping me if you're interested in my personal reading list!

Goals

• Plaintext and friendly data format.
• Minimal hosting and deployment overhead.
• Offline editing support.

Technologies Used

• Linux and OSX. Windows should also work with Cygwin, but I haven't tried. Please file any issues related to this.
• YAML data.
• GitHub Pages hosts and automatically deploys a 100% client-side website that can also be edited offline. Bower manages 3rd party library dependencies used on the site, stored in bower.json.

Creating Your Reading List: Quick Start

1. Fork or copy the contents of this repository into a new GitHub repository. Make sure the default branch is set to gh-pages for deployment. At this point, you should be able to see my site hosted at. http://<your-github-name>.github.io/reading-list
2. Update the data and personalize index.html. Push your changes to GitHub to see them immediately on the new site.
3. Replace links to http://bamos.github.io/reading-list with your URL.

Local Deployment

Most browsers will not be able to open index.html directly from the filesystem because the js loads YAML resources. One workaround is to use start a simple Python static web server with python2 -m SimpleHTTPServer and access the website with localhost:8000.

Updating Bower Dependencies

Run bower update to obtain the dependencies in bower_components. Run ./update-vendor-deps.sh to copy the necessary portions into vendor.

Scripts

The scripts directory contains Haskell and Ruby scripts to select random books and quotes from data/finished.yaml.

Import from Goodreads

The Goodreads Ruby script by @seanosaur uses Goodreads' API to import books into data files. Please follow their ToS and add appropriate references to Goodreads if this is used.

Warning: This script only pulls the first 200 books. Improvements to this are being tracked in this issue.

Inspiration

The following projects inspired me to create a GitHub-hosted reading list.

People using this repo for their reading list

Ping me if you'd like to be added or removed.

Credits and Licensing

All portions are MIT licensed by Brandon Amos unless otherwise noted.

This project uses and modifies the following open source projects and resources. Modifications remain under the original license.