Skip to content

boazsender/coral-ask-election-2016

 
 

Repository files navigation

Coral Ask Election Reactions

A prototype application to visualize reactions to the outcome of the 2016 election.

Installation

Copy the file config.sample.json in the project root to config.json, then set the values of each key to match your deployment.

Quick Start

To get started quickly with local development, just save this JSON as config.json in the project root:

{
  "jsonURI": "http://localhost:3000/data/",
  "formId": "581118892b74a9ceb5c309ab",
  "googleSheetId": "18yAMk_ydGpPLHTZPrLox7oplvgc-4aswu1arO_IHY9I"
}

Configuration Guide

jsonURI:

This field holds the URI at which the JSON files output by Ask can be located over HTTP. For local development this will likely be "http://localhost:3000/data/", but in production it will usually be a URL to the location on Amazon S3 to which Ask uploads its JSON.

formId:

If you have a local instance of Coral Ask running at, say, localhost:2020, when you're editing the form you wish to use to drive this visualization you will be at a URL similar to this:

http://localhost:2020/forms/581118892b74a9ceb5c309ab

"581118892b74a9ceb5c309ab" is your formId. This ID is combined with the jsonURI to locate the JSON data files that will be loaded.

googleSheetId:

Editorial text fields in this visualization and the non-user-editable text of the "letter to the president" that is assembled from the responses is managed through Google Sheets: create a publicly-visible spreadsheet document by duplicating this sheet. Once your sheet is set up, copy the ID out of the spreadsheet URL; for the URL

https://docs.google.com/spreadsheets/d/18yAMk_ydGpPLHTZPrLox7oplvgc-4aswu1arO_IHY9I/edit#gid=904229865

"18yAMk_ydGpPLHTZPrLox7oplvgc-4aswu1arO_IHY9I" is your googleSheetId.

Development

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

npm test

Runs the unit tests.

Data

The data used by this application is not included in this repo, but is expected to be placed in public/data/data.json.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 53.3%
  • CSS 36.5%
  • HTML 10.2%