This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
Services (job queues, cache servers, search engines, etc.)
Wolfram Alpha API (although seeding isn’t currently working…API times out)
Name: Declan_Van_Welie Email: email@example.com GitHub: github.com/declanv
Project 1 Planning & Deliverables:
This app allows users to create an account, log in, and enter a birth year and death year (or present if still alive). The app will deliver back a timeline of historical events mapping to milestones in the person's life, based on their birth year and lifetime range.
The app is intended to be entertaining in visualizing historical events in one’s lifetime. It's also supposed to be educational. I foresee the end-user searching the birthdate of their grandparents to better understand what their grandparents' or great-grandparents’ lives might have been like.
The features are pretty straightforward. The user will enter one or two pieces of information: their birth year (or day) and their (or their relative/friends’) death year. The input will call up a timeline that will return information for major milestones in one’s life.
There were plenty of roadblocks along the way in getting the app to this point, but the biggest obstacle turned out to be an issue with the Wolfram Alpha API not consistently returning desired results. The query works about half the time, and times out otherwise. This prevented me from seeding my database on Heroku, although I was able to seed some information locally.
I'm happy to have learned more about the rails structure, and to have gained more experience working with APIs.
The app includes the following four models: users, timelines, milestones, and years. The milestones model is the join table between milestones and timelines.
Ruby on Rails guides: guides.rubyonrails.org/
ActiveRecord query: guides.rubyonrails.org/active_record_querying.html
Google Fonts: www.google.com/fonts
Wolfram Alpha: products.wolframalpha.com/api/
Wolfram Alpha gem: github.com/cldwalker/wolfram
Wolfram Alpha API Documentation: products.wolframalpha.com/docs/WolframAlpha-API-Reference.pdf
Google Custom Search API: developers.google.com/custom-search/json-api/v1/overview
Google Code Playground: code.google.com/apis/ajax/playground/#large_result_set
Microsoft Getty Images Historical image API: github.com/gettyimages/connect
Flickr api: www.flickr.com/services/api/
Yahoo images API: developer.yahoo.com/boss/search/
Youtube API: developers.google.com/youtube/