Skip to content

Commit

Permalink
Merge pull request debugger22#31 from jennylia/master
Browse files Browse the repository at this point in the history
added some details to README
  • Loading branch information
debugger22 authored Oct 21, 2016
2 parents 1a3be3a + 5be2b66 commit bdb0b48
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ jspm_packages

# Optional REPL history
.node_repl_history

# Optional for people who uses JetBrains products
*.idea
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,20 @@ But seriously, [listen-to-wikipedia](https://github.com/hatnote/listen-to-wikipe
<sub><sup><sub><sup>Use [`ULTIMATE_DREAM_KILLER`](https://github.com/debugger22/github-audio/commit/ed47067f5e56ab70d65fa31f72bf2dbc513f8f56) to filter all events except closed PRs.


Media
Media Attention
-----

* [The Next Web](http://thenextweb.com/apps/2016/10/03/this-site-tracks-events-across-github-to-generate-calming-work-music/)
* [Product Hunt](https://www.producthunt.com/tech/github-audio)


Installation on OSX
# Installing dependencies

This application requires:
* node
* npm
* redix

Dependency Installation on OSX
-------------------

```bash
Expand All @@ -26,7 +32,7 @@ $ brew install npm
$ brew install redis
```

Installation on Linux
Dependency Installation on Linux
---------------------

```bash
Expand All @@ -36,6 +42,7 @@ $ sudo apt-get install npm
$ sudo apt-get install redis-server
```

# Running the Application
Install node packages
---------------------

Expand All @@ -54,11 +61,17 @@ $ export GITHUB_OAUTH_KEY=<your_github_oauth_key>

Note: Without the GitHub oauth key the number of requests is throttled at 60 per hour. It can be increased to 5000 per hour by using an oauth key.

Run server
Run Redis and Server
----------

```bash
$ redis-server
```

In a separate window:
```bash
$ node server
```

Note: For production run `export NODE_ENV="production"` before starting the server.

2 changes: 1 addition & 1 deletion app/public/js/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var svg_background_color_online = '#0288D1',



var socket = io(document.location.hostname);
var socket = io();
socket.on('github', function (data) {
$('.online-users-count').html(data.connected_users);
data.data.forEach(function(event){
Expand Down

0 comments on commit bdb0b48

Please sign in to comment.