Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkkelly committed Feb 5, 2015
1 parent 3f96049 commit ec22cd7
Showing 1 changed file with 37 additions and 5 deletions.
42 changes: 37 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,23 @@
[gemnasium]: https://gemnasium.com/codeforamerica/citygram
[codeclimate]: https://codeclimate.com/github/codeforamerica/citygram

__Citygram__ is a geographic notification platform designed to work with open government data. It allows residents to designate area(s) of a city they are interested in and subscribe to one or more topics. When an event for a desired topic occurs in the subscriber's area of interest, a notification (email, SMS, or [webhook](http://en.wikipedia.org/wiki/Webhook)) is delivered. Citygram is a [Code for America](https://github.com/codeforamerica) project by the [Charlotte](http://team-charlotte.tumblr.com/) and [Lexington](http://teambiglex.tumblr.com/) teams for the [2014 fellowship](http://www.codeforamerica.org/geeks/our-geeks/2014-fellows/).
__Citygram__ is a geographic notification platform designed to work with open government data.
It allows residents to designate area(s) of a city they are interested in and subscribe to one or more topics.
When an event for a desired topic occurs in the subscriber's area of interest, a notification (email, SMS, or [webhook]) is delivered.
Citygram is a [Code for America] project by the [Charlotte] and [Lexington] teams for the [2014 fellowship].

[webhook]: http://en.wikipedia.org/wiki/Webhook
[Code for America]: https://github.com/codeforamerica
[Charlotte]: http://team-charlotte.tumblr.com/
[Lexington]: http://teambiglex.tumblr.com/
[2014 fellowship]: http://www.codeforamerica.org/geeks/our-geeks/2014-fellows/

### Why are we doing this?

We believe that there is an opportunity to help residents better understand what’s going on in their area, when it’s going to happen, and why. By providing timely information to residents in areas that are relevant to them, the city can be proactive instead of reactive, build trust through transparency, and increase civic engagement across the board.
We believe that there is an opportunity to help residents better understand what’s going on in their area,
when it’s going to happen, and why. By providing timely information to residents in areas that are relevant to them,
the city can be proactive instead of reactive, build trust through transparency, and increase civic engagement
across the board.

### Who is this made by?

Expand All @@ -32,20 +44,40 @@ Citygram is a web application written in Ruby.

In the command line, run the following:

#### Install Dependencies

```
git clone https://github.com/codeforamerica/citygram.git
cd citygram
cp .env.sample .env
rbenv install local
brew install postgresql postgris
gem install bundler
bundle install
```

#### Configure Environment

```
cp .env.sample .env
rake db:create db:migrate
rake db:create db:migrate DATABASE_URL=postgres://localhost/citygram_test
rake # run the test suite
bundle exec rackup
```

### Developing

To boot up the complete application and run background jobs in development:

```
bundle exec foreman start -f Procfile.dev
open http://localhost:9292/new-york
```

You can now see your site at

### Testing

Run all tests in the `spec/` directory.

```
rake
```

0 comments on commit ec22cd7

Please sign in to comment.