Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pjIowa authored and pjkedilaya committed Jan 31, 2016
1 parent c2665a4 commit 54f1101
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TNode
* touch your data for the first time
Touch your data for the first time


# Why
This started off as an experiment in using D3 to display tweets collected from a Python script.
Expand All @@ -19,8 +20,8 @@ so that people can interact with their data easier. Continue if you like.


# Installation Steps
* Install Postgres, link for download: http://www.postgresql.org/download/
* Install NodeJS, link for downlaoad: https://nodejs.org/en/download/
* Install Postgres, use the link to download: http://www.postgresql.org/download/
* Install NodeJS, use the link to downlaoad: https://nodejs.org/en/download/

# Usage Steps
* The app uses data from the Twitter API, here are steps to get credentials to use it:
Expand All @@ -34,7 +35,17 @@ so that people can interact with their data easier. Continue if you like.
<dd>7. Click Create my access token on the bottom to contine. </dd>
<dd>8. Copy the values for these four fields into a new json file: Consumer Key, Consumer Secret, Access Token, and Access Token Secret. </dd>
</dl>
* Notes on adding credentialsDB and credentialsTwitter
* The app needs a credentialsDB to access your Postgres database:
<dl>
<dd>1. Create a new file called credentialsDB.json. </dd>
<dd>1. Save the file under TNode->router. </dd>
<dd>2. Click on the Postgres application to start the PostgreSQL Server on your machine. </dd>
<dd>3. Open psql, the command line interface for your PostgreSQL server. </dd>
<dd>4. If your server is not password-secured, run the following command: ALTER ROLE your_username WITH PASSWORD 'your_password'; </dd>
<dd>5. If you haven't made a database yet, run the following command: CREATE DATABASE your_db_name;</dd>
<dd>6. Add a JSON dictionary with the keys: username, password and dbname, then add the values you just set. Save the JSON dictionary to the file. </dd>
</dl>
* Notes on adding credentialsTwitter
* Note to run npm install
* Notes to run Node app and postgres server
* Notes to replace Twitter as a data source
Expand All @@ -45,4 +56,4 @@ so that people can interact with their data easier. Continue if you like.
* FIPS code to population and land area data: http://quickfacts.census.gov/qfd/download_data.html
* FIPS code to state, county name: http://www.schooldata.com/pdfs/US_FIPS_Codes.xls
* TopoJSON files for D3 rendering: http://bl.ocks.org/mbostock/raw/4090846/us.json
* Choropleth coloring: http://bl.ocks.org/mbostock/4060606
* Choropleth coloring: http://bl.ocks.org/mbostock/4060606

0 comments on commit 54f1101

Please sign in to comment.