@@ -86,7 +86,93 @@ The current crontab entries look like: */5 * * * * /engineyard/custom/cron_wrapper bostonrb get_tweets production 'rake get_tweets' */5 * * * * /engineyard/custom/cron_wrapper bostonrb get_blogs production 'rake get_blogs' + +## Tools and libraries used + +Here is a list, in no particular order, of the libraries and other tools used, and how or why we're using them. +### [RedCloth](http://redcloth.org/) + +Library for generating HTML from [textile](http://redcloth.org/textile) markup. We use this so we don't have to have users enter HTML for descriptions of jobs, events, etc + +### BlueCloth + +Library for generating HTML from [markdown](http://daringfireball.net/projects/markdown/) markup. We use this so we don't have to have users enter HTML for descriptions of jobs, events, etc + +### le-git + +A library by Josh Nichols and Dan Croak to access the [GitHub API](http://develop.github.com/). Users enter their GitHub username when setting up an account, and we use le-git to aggregate them. + +### twitter-search + +A library by Dan Croak to access the [Twitter Search API](http://apiwiki.twitter.com/Twitter-API-Documentation). Users enter their Twitter usernames when setting up an account, and we use twitter-search to aggregate them. + +### fakeweb + +A test library that lets you intercept network connections setup by [net/http], and setup canned responses for them. + +We use this to make sure no network connections happen during testing. + +### feedra + +A library by Josh Nichols that lets you easily setup add feed aggregation to a Rails app. + +We use this to let users and companies enter the URL of their blog feed, so we can aggregate it. + +### gravtastic + +A library for interacting with [gravatar](http://en.gravatar.com/). + +We use this to display user gravatars on the front page. + +### haml + +### mocha + +### inherited_resources + +### has_markup + +### clearance + +### factory_girl + +### pacecar + +### shoulda + +### truncate_html + +An extension to ActionView written by Harold Gimenez to truncate + +### will_paginate + +An extension to ActiveRecord to allow for easily pagination of queries. + +We usually use this on index pages, where we want to show several smaller pages of results, rather than one extremely long one. + +### bootstrapper + +### fast_random + +An extension to ActiveRecord written by Harold Gimenez to provide a database asgnostic named_scope to get a random record. + +We use this to + +### geokit + +A library which can geocode an address into a latitude and longitude. We use this geocode the addresses of our events, so we can display a Google map to them in combination with Google Maps + +### hoptoad_notifier + +### validates_email_format_of + +A plugin to add an ActiveRecord validation method for emails. This is used to validate a user's email address. + +### validates_url_format_of + +A plugin to add an ActiveRecord validation method for URLs. This is used to validate a user's website URL. + ## Hosting EngineYard is super awesome and provides us with a production environment. [Josh Nichols](http://github.com/technicalpickles) and [Dan Croak](http://github.com/dancroak) have access to it if any changes need to be deployed. @@ -103,4 +189,4 @@ To contribute, you should fork on GitHub, make your changes, and then either com Dan Croak, Josh Nichols, Harold Gimenez, Dan Pickett, Rebecca Frankel, Joe Ferris. -Design by Angelo Simeoni. \ No newline at end of file +Design by Angelo Simeoni. README.markdown 810351581555a69e8ec7d4633679b1757ec29046 Joshua Nichols josh@technicalpickles.com http://github.com/bostonrb/bostonrb/commit/d8be07a98e150975e1061428461277a2d079e4e8 d8be07a98e150975e1061428461277a2d079e4e8 2009-10-23T00:16:39-07:00 2009-10-23T00:16:30-07:00 Added some notes about the libraries we're using. 26399b13f0f7caba01d73463fcc57b3822b319eb Joshua Nichols josh@technicalpickles.com