Browse Source

Improved README

master
Adrian Short 12 years ago
parent
commit
71fd91255c
1 changed files with 39 additions and 0 deletions
  1. +39
    -0
      README.md

+ 39
- 0
README.md View File

@@ -1,3 +1,31 @@
Apollo
======

A [GeoRSS](http://en.wikipedia.org/wiki/GeoRSS) aggregator and augmented reality server for [Layar](http://layar.com/)

© 2012 Adrian Short and Charlotte Gilhooly at [Headline Data](http://headlinedata.com/)

This software was commissioned by [Talk About Local](http://talkaboutlocal.org.uk/) as part of the [HypARlocal](http://talkaboutlocal.org.uk/ar/) project.

HypARlocal is funded by [NESTA](http://www.nesta.org.uk/destination_local) and the [Nominet Trust](http://www.nominettrust.org.uk/).

What it does
------------

Periodically

Requirements
------------

* Rails 3
* MongoDB
* MongoMapper
* Feedzilla


Installation
------------

Before installing/deploying:

$ export APOLLO_HOSTNAME=example.org
@@ -7,3 +35,14 @@ On Heroku:
$ heroku config:add APOLLO_HOSTNAME=example.org

Replace `example.org` with your own hostname. When running locally this will probably be `localhost:3000`.

Set up a cron job or other scheduler to run

$ rake get_all_feeds
once per hour or to taste.

Now create yourself a user account from the console:

$ rails c
> User.create :email => "me@example.org", :password => "verysecret", :password_confirmation => "verysecret"

Loading…
Cancel
Save