Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 55 lines (39 sloc) 3.083 kb
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
1 About
2 -----
3
4 Potential friend finder is a demo app for a simple version of the _People You May Know Algorithm_ used on [Gowalla](http://gowalla.com). You can check out the real-algorithm in-action on the web by signing up for a [Gowalla](http://gowalla.com) account and adding friends. For more information please check out the source code, and watch the attached video and presentation
5
6 Screencast of the presentation on: [Vimeo](http://www.vimeo.com/22997846)
7
8 Slides of the presentation: [How Richard Found Friends (Slideshare)](http://www.slideshare.net/thinkbohemian/potential-friend-finder)
9
10
78a546b @schneems documentation
authored
11 Install
12 -------
2d5b48d @schneems update readme and new css
authored
13 1) git clone git@github.com:Schneems/Potential-Friend-Finder.git
14 2) cd Potential-Friend-Finder
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
15 2.1) # if you don't have homebrew install it homebrew https://github.com/mxcl/homebrew/wiki/installation
16 2.2) brew install imagemagick # if you don't have imagemagick
2d5b48d @schneems update readme and new css
authored
17 3) bundle install
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
18 4) rails server
2d5b48d @schneems update readme and new css
authored
19
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
20 Note: requires memcache and redis. I recommend using [RVM](https://rvm.beginrescueend.com/) to manage your Rubies.
78a546b @schneems documentation
authored
21
22 Use
23 ---
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
24 Navigate to [http://localhost:3000](http://localhost:3000) on your computer. Create an admin account, this will allow you to add 'users' to your mini-social network. Once you have users, you can make friends, and observe what our potential friends algorithm suggests.
78a546b @schneems documentation
authored
25
26
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
27 Contribute
28 ----------
29 Please fork this project, and see if you can come up with improvements to the algorithm. If you want me to pull your fork later, please make your changes on a branch, and give the user some way to toggle between your algorithm and the original algorithm. Putting all your methods in a module and extending user.rb would be an easy way to accomplish this
78a546b @schneems documentation
authored
30
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
31 If you want to contribute and you need to reach me, you can find me on the twitters [@Schneems](http://twitter.com/schneems)
78a546b @schneems documentation
authored
32
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
33 Also want to give a shout out to [@mattt](http://twitter.com/mattt) ([Mattt on Github](http://github.com/mattt)) for clueing me into friends-of-a-friend graph theory...he is awesome.
9a55928 @schneems shoutout to @mattt in documentation
authored
34
78a546b @schneems documentation
authored
35 Copyright (c) 2011 Schneems
27d8382 @schneems Readme: Correct spelling, make license more visible, put about section f...
authored
36
37 Permission is hereby granted, free of charge, to any person obtaining
38 a copy of this software and associated documentation files (the
39 "Software"), to deal in the Software without restriction, including
40 without limitation the rights to use, copy, modify, merge, publish,
41 distribute, sublicense, and/or sell copies of the Software, and to
42 permit persons to whom the Software is furnished to do so, subject to
43 the following conditions:
44
45 The above copyright notice and this permission notice shall be
46 included in all copies or substantial portions of the Software.
47
48 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
49 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
50 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
51 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
52 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
53 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
54 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.