Skip to content
This repository has been archived by the owner on Jun 8, 2020. It is now read-only.

Commit

Permalink
Improve trackers documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SamyPesse committed Oct 17, 2013
1 parent 4135f66 commit b398e81
Showing 1 changed file with 23 additions and 40 deletions.
63 changes: 23 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,39 +30,15 @@ $ git clone https://github.com/SamyPesse/reportr.git && cd ./reportr

#### Configuration

Configure the Reportr instance using Heroku config vars or define these variables in a **.env** file for local use:
Configure the Reportr instance using Heroku config vars or define these variables in a **.env** file for local use.
Configure the differents trackers using Trackers list below.

```
# Host name
HOST
# Express Secret session
SESSION_SECRET
# Foursquare oAuth
# Callback url is {HOST}/auth/foursquare/callback
FOURSQUARE_CLIENTID
FOURSQUARE_CLIENTSECRET
# GitHub oAuth
# Callback url is {HOST}/auth/github/callback
GITHUB_CLIENTID
GITHUB_CLIENTSECRET
# Facebook oAuth
# Callback url is {HOST}/auth/facebook/callback
FACEBOOK_CLIENTID
FACEBOOK_CLIENTSECRET
# Twitter oAuth
# Callback url is {HOST}/auth/twitter/callback
TWITTER_CLIENTID
TWITTER_CLIENTSECRET
# Runkeeper oAuth
# Callback url is {HOST}/auth/runkeeper/callback
RUNKEEPER_CLIENTID
RUNKEEPER_CLIENTSECRET
```

#### Create your application and deploy it
Expand Down Expand Up @@ -121,21 +97,28 @@ make deploy

## Trackers

Here is a list of trackers, I already built:

* Web Navigation: track web navigation using a Chrome extension
* Instance ping: ping state of the Reportr instance
* Foursquare: track checkins
* GitHub: track coding activity on GitHub
* Facebook: track relations on Facebook (using Realtime API)
* Twitter: track twitter activity (tweets, mentions, ...)
* Runkeeper: track running activity

And more to come:
| State | Name | Description | Configuration |
|:-----:| ------------------- | ----------------- | ----------------- |
| X | *Web Navigation* | Track web navigation using a Chrome extension | |
| X | *Ping* | Ping state of the Reportr instance | |
| X | *Foursquare* | Track your checkins | Callback url is /auth/foursquare/callback |
|||| FOURSQUARE_CLIENTID |
|||| FOURSQUARE_CLIENTSECRET |
| X | *GitHub* | Track coding activity on GitHub | Callback url is /auth/github/callback |
|||| GITHUB_CLIENTID |
|||| GITHUB_CLIENTSECRET |
| X | *Facebook* | Track relations on Facebook | Callback url is /auth/facebook/callback |
|||| FACEBOOK_CLIENTID |
|||| FACEBOOK_CLIENTSECRET |
| X | *Twitter* | Track twitter activity (tweets, mentions, ...) | Callback url is /auth/twitter/callback |
|||| TWITTER_CLIENTID |
|||| TWITTER_CLIENTSECRET |
| X | *Runkeeper* | Track fitness activity from Runkeeper | Callback url is /auth/runkeeper/callback |
|||| RUNKEEPER_CLIENTID |
|||| RUNKEEPER_CLIENTSECRET |
| - | *Fitbit* | Track fitness activity from Fitbit | |
| - | *Temperature* | Track the temperature in a room (using tessel.io) | |

* Fitbit
* Hardware:
* Track the temperature in a room (using tessel.io)

## APIs

Expand Down

0 comments on commit b398e81

Please sign in to comment.