-
Notifications
You must be signed in to change notification settings - Fork 91
Going Live
The reference deployment of this repository runs at citygram.org. The operators of that platform are currently open to bringing cities online free of charge, but a two-step process needs to be completed in order to do so. This page outlines those steps.
We need to add your city to our GeoJSON list of providers in order to place your city on the drop-down menu on our homepage. We also need to display a high-resolution image of your city to be shown in the background of your "City" page, where residents will subscribe to your feeds. For an example of a successful pull request that accomplishes these tasks, refer to this PR from San Francisco.
In order to have something to show in your list of subscriptions, we need to add some data to the operational database. That can be done with an incantation into a console like the following:
Publisher.create! do |pub|
pub.title = "Tree Plantings"
pub.endpoint = "https://location-changed-5314.herokuapp.com/tree-planting"
pub.active = false
pub.visible = false
pub.city = "San Francisco"
pub.icon = "leaf-collection.png"
pub.state = "CA"
pub.description = "List of trees planted along SF streets by Department of Public Works."
pub.tags = ["san-francisco"]
end
For each dataset you want to publish on Citygram, I'll need one incantation like the above that matches the dataset in question. There are a few important items there to get right. I'm including them here in rough order of importance.
Tags are included directly in the URL for your City page, so we prefer hypens to underscores in place of spaces here. For best results, match the id of your GeoJSON in config/cities.geojson file. Datasets must be tagged correctly to be fetched.
Title and description will provide the primary user interface the resident will experience when surveying your datasets. Make it clear and easy to understand. Prefer shorter descriptions to longer ones.
Your icon selection either needs to be one of these or you need to include an appropriate icon in a pull request in addition.
When a dataset is marked as active, Citygram will attempt to visit the URL and begin processing events. When a dataset is marked visible, it will appear on Citygram for the public to subscribe to. Depending on the specifics regarding your dataset, we might choose to phase your data in rather than go public with it immediately.