README.md

bobcat

MEAN stack plus d3.js to visualize availability of rental bikes across London
See the currently deployed version here

What

This project was intended to be a learning exercise to help get to grips with the basics of Angular.js, Leaflet.js and to use d3.js to help visualize a live data set. The idea originally came from what I believe to be a fairly unclear user interface on the official TFL Santander Cycle hire availability map. I thought I could create a clearer, more user friendly alternative that would offer certain functionality that the TFL site was missing.

Features that I want to include that TFL is missing:

• The ability to clearly see at a single glance how many bikes were available at each docking station
• The ability to toggle modes depending on if you were searching for a bike to hire or a station to dock your bike at

Other features to add:

• User profiles so users can store a favourite location that the view defaults to

How

The data itself comes from TFL and is freely available (if you register as a developer) from https://tfl.gov.uk/tfl/syndication/feeds/cycle-hire/livecyclehireupdates.xml as an XML document. The data contains information on every bike docking station in london, including latitude and longitude, the total number of docks and the number of bikes currently available. This data is updated around every two minutes.

If you would like to run this project locally, you can git clone the repo from https://github.com/rorysedgwick/bobcat.git and npm install the dependencies. You will need a creds.json file of the same structure as creds.example.json, with the sections between replaced with your mongolabs database credentials. npm start will compile from the /src folder into /public and start the server, making the project available to view at localhost:8000

---

To do:

• Detailed readme
• Modularise
• Set up test framework
• Write tests for existing code
• Set up cloud database (mongolabs?)
  • Finalise data structure
  • Populate database with bikepoint details
• Pull live data from tfl
• Integrate interactive map (leaflet?)
• Map bike stations
• Include d3 display of available bikes
• Flesh out home page with info
• Consider wording and SEO
• Add "updating" animation or signal for user on data refresh
• Deploy
• Add google analytics
• ??????
• Profit

Major issue

Due to the free tier of heroku apps sleeping when not in use, the database ceases to update itself with TFL data. Therefore when a user first visits the page and the site "wakes up", the data displayed will often be out of date by a matter of hours. Updated data will then be displayed only once both the backend polling of TFL has taken place, and the front end has completed a periodic refresh (currently every 25 seconds). This means the user either has to wait an unspecified amount of time before the data is accurate, or will unknowingly use innaccurate data. Due to the informative and accessible nature of this service, neither option is acceptable.

Solutions:

• Scale dynos up to a paid tier of Heroku (unlikely while the project is simply a hobby/learning exercise)
• Find alternative deployment option that does not sleep when not in use (Azure? Free trial probably covers it, only 30 days. AWS? EC2 available until 12 months after signup)
• Warn users they may need to wait for data to be accurate (do not really consider this an option)
• Clearly display a time and date for when data was last updated (intending to do so anyway but not as a warning to users)
• Remove backend completely and have client polling TFL site directly (limit to number of HTTP requests the app can make? Not a scalable option)
• Have backend polling TFL extremely regularly so when app "wakes up" data should be updated within first few seconds (need to increase front end refresh to a similar regularity. How many concurrent request can a mongolabs instance take? investigate)
• Increase site traffic to a level that means the dyno never goes to sleep (think this will bump the dyno into the heroku paid tier)