Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo #53

Open
wants to merge 127 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
127 commits
Select commit Hold shift + click to select a range
f25712b
Writing null to client
debugger22 Sep 30, 2016
e95e5c8
Add shebang
debugger22 Sep 30, 2016
ce2a922
Correct shebang
debugger22 Sep 30, 2016
ee81ef6
Use nodejs in shebang
debugger22 Sep 30, 2016
33acf4c
Add logger and fix architecture
debugger22 Sep 30, 2016
33fcc98
Fix URL issue
debugger22 Sep 30, 2016
f8103d2
Use window.location.href for hostname
debugger22 Sep 30, 2016
498a43b
Fix socket URL
debugger22 Sep 30, 2016
756b6e3
Fix url
debugger22 Sep 30, 2016
2f5dafe
Fix unsafe script issue
debugger22 Sep 30, 2016
987ab82
Fix url issue
debugger22 Sep 30, 2016
9160a17
Add sounds/static-files and soem tweaks
debugger22 Sep 30, 2016
3c1ee95
Change default port back to 8000
debugger22 Sep 30, 2016
3f054ad
Fix favicon path
debugger22 Sep 30, 2016
6866448
Beautify data and save connected users in redis
debugger22 Sep 30, 2016
f657906
Add helmet to the app
debugger22 Sep 30, 2016
9a1dbb2
Use helmet for properly applying security headers
debugger22 Sep 30, 2016
bc96573
Explicitly disable x-powered-by header
debugger22 Sep 30, 2016
290ba5a
Start working on client"
debugger22 Sep 30, 2016
3e5e222
Font size fixes
debugger22 Sep 30, 2016
610442c
Add odometer for connected users' animation
debugger22 Sep 30, 2016
6e52faa
Start playing sounds
debugger22 Oct 1, 2016
387112e
Circle drawing stating to work
debugger22 Oct 1, 2016
cba3eca
Add colorsnode server --port=8000 💄
debugger22 Oct 1, 2016
8cd078f
Add google-analytics
debugger22 Oct 1, 2016
6037c2e
More cleanup and bug fixes
debugger22 Oct 1, 2016
7be7e1b
Add social buttons and some cleanup 💄
debugger22 Oct 1, 2016
21b15aa
Tweak params to improve music
debugger22 Oct 1, 2016
3577ac6
Remove debug port no
debugger22 Oct 1, 2016
5fb28d4
No active listeners
debugger22 Oct 1, 2016
6fe61c1
set buffer: true in Howl to fix issues on Android and iOS
debugger22 Oct 1, 2016
c24ebe9
Add mute/unmute feature
debugger22 Oct 1, 2016
bdb0834
Enable active users
debugger22 Oct 1, 2016
f1b6f77
Add ProTip
debugger22 Oct 1, 2016
8b9923e
Add tags in the tweet data
debugger22 Oct 1, 2016
72f2720
Reduce default volume
debugger22 Oct 1, 2016
40d1a43
Change mute icons and speed up music a little
debugger22 Oct 2, 2016
98713cd
Fix a typo in README
debugger22 Oct 2, 2016
7f3fa20
Use minified d3 and socket
debugger22 Oct 2, 2016
4e0fb59
No need to initialize connected_users with 0
debugger22 Oct 2, 2016
fa60c7d
Disable horizontal scrolling and some UI fixes for mobile. Increase q…
debugger22 Oct 2, 2016
7e5ef62
Don't make social buttons fixed
debugger22 Oct 2, 2016
3ab7239
Make area fit to screen
andrewda Oct 2, 2016
71322c0
Merge pull request #4 from andrewda/screen-size
debugger22 Oct 2, 2016
577b402
Some improvements to graphics
debugger22 Oct 2, 2016
d1ca1d9
Remove overflo-y:scroll
debugger22 Oct 3, 2016
f502894
Add media links to README
debugger22 Oct 3, 2016
eb771c2
Remove text shadow
debugger22 Oct 3, 2016
77680c6
Oops! Put the shadows back
debugger22 Oct 3, 2016
9528621
Remove html of decayed events
debugger22 Oct 3, 2016
2fa2e88
Disable setting area height using CSS
debugger22 Oct 3, 2016
a3d107f
Give credit to listen-to-wikipedia in README
debugger22 Oct 4, 2016
8d5b6b9
Add voume control closes #2
debugger22 Oct 4, 2016
2191f04
Fix formatting in README
debugger22 Oct 4, 2016
1975558
Add slaported to README
debugger22 Oct 4, 2016
14de07d
Fix volume slider touch on mobile devices
debugger22 Oct 4, 2016
2a8deed
Update README.md
chaudharyprakash Oct 4, 2016
07fa551
Add About section
debugger22 Oct 4, 2016
2270c3f
Hide events remaining text by default
debugger22 Oct 4, 2016
3321235
Hide visibility text by default
debugger22 Oct 4, 2016
e1170da
Merge pull request #12 from chaudharyprakash/patch-1
debugger22 Oct 4, 2016
a5d203d
Use CloudFront for sounds
debugger22 Oct 4, 2016
196f837
Merge branch 'master' of https://github.com/debugger22/github-audio
debugger22 Oct 4, 2016
203a79f
Fix issue with safari
debugger22 Oct 4, 2016
06e6421
Fix syntax error on Old Safari. Thanks to @Cardoso222
debugger22 Oct 4, 2016
b36c285
Add function to ignore events
mcornella Oct 5, 2016
ed47067
Add easter egg to only play closed PRs
mcornella Oct 5, 2016
b7d9d60
Remove mute button contents
debugger22 Oct 5, 2016
53c8f33
Try to fix sound issue on iPhone
debugger22 Oct 5, 2016
f24b881
Revert sound hack for iPhone. Didn't work! :/
debugger22 Oct 5, 2016
b7e7aa7
Merge pull request #18 from mcornella/patch-1
debugger22 Oct 5, 2016
79b2d91
Remove mute leftovers
debugger22 Oct 5, 2016
143c1c2
Merge branch 'master' of https://github.com/debugger22/github-audio
debugger22 Oct 5, 2016
aaa0961
Initiate ULTIMATE_DREAM_KILLER to avoid errors
debugger22 Oct 5, 2016
aa87aaf
Filter events before playing instead of before queuing
mcornella Oct 5, 2016
d31b9c8
Merge pull request #19 from mcornella/patch-1
debugger22 Oct 5, 2016
e4d1dce
Increase the queue size to 1000; new users won't miss events
debugger22 Oct 5, 2016
31ec3b0
Merge branch 'master' of https://github.com/debugger22/github-audio
debugger22 Oct 5, 2016
d4c8907
Hide easter egg in plain sight :smiling_imp:
mcornella Oct 5, 2016
723b5c5
Merge pull request #20 from mcornella/patch-1
debugger22 Oct 5, 2016
ad1b98e
Add a missing T in ULTIMATE_DREAM_KILLER
debugger22 Oct 5, 2016
1548d8a
Add twitter follow button
debugger22 Oct 5, 2016
6f9e54e
Merge branch 'master' of https://github.com/debugger22/github-audio
debugger22 Oct 5, 2016
e0b6990
optimize png images using zopflipng
PeterDaveHello Oct 6, 2016
b6c99cb
Merge pull request #23 from PeterDaveHello/image-optimize
debugger22 Oct 6, 2016
a1b0a6c
use minified odometer.js on CDNJS to benefit from http/2
PeterDaveHello Oct 6, 2016
8a88284
Merge pull request #22 from PeterDaveHello/odometer.js-cdnjs
debugger22 Oct 6, 2016
a2a13f2
Get rid of ugly loading
debugger22 Oct 7, 2016
60609a2
Don't limit events except push events
debugger22 Oct 7, 2016
fff14e7
Remove an unused variable
debugger22 Oct 7, 2016
7e51f39
Add ref. to ULTIMATE_DREAM_KILLER
debugger22 Oct 7, 2016
ae5b203
Add a feature to filter out events of specified repos/orgs
debugger22 Oct 7, 2016
c4a763a
Always draw irrespective of screen visibility
debugger22 Oct 7, 2016
c1cfa27
Merge pull request #25 from debugger22/feat-filter-org/user
debugger22 Oct 7, 2016
b0c1b0e
Don't always draw but draw when filter is on irrespective of the scre…
debugger22 Oct 7, 2016
684dd31
Fix syntax error
debugger22 Oct 7, 2016
0d9e7ac
Fix draw issue on hidden screen
debugger22 Oct 10, 2016
864d3ea
Add binaries for macOS and Linux
debugger22 Oct 13, 2016
afaa324
Move bin to static
debugger22 Oct 13, 2016
ecae20e
Add app links to website
debugger22 Oct 13, 2016
53961da
Add an extra line break for apps text
debugger22 Oct 13, 2016
1a3be3a
Update index.html
debugger22 Oct 14, 2016
5be2b66
added some details to README
jennylia Oct 21, 2016
bdb0b48
Merge pull request #31 from jennylia/master
debugger22 Oct 21, 2016
9ccb7a3
Add cross-env dependency so that `npm start' works
mcornella Oct 9, 2016
5301419
Set `merged' action if `merged' key is true
mcornella Oct 9, 2016
c5a04f3
Add URL field for each event
mcornella Oct 9, 2016
212260b
Merge pull request #27 from mcornella/mixed-improvements
debugger22 Oct 21, 2016
e58dbec
Typo fix
gowthamgts Oct 30, 2016
e995be6
Merge pull request #33 from gowthamgts/patch-1
debugger22 Nov 2, 2016
819cf46
Add missing commas
emsk Nov 6, 2016
7a98329
Merge pull request #35 from emsk/missing-commas
debugger22 Nov 11, 2016
3337475
Add DigitalOcean logo to the website
debugger22 Nov 11, 2016
722bff8
Get rid of connected users
debugger22 Nov 14, 2016
84508ac
Change project name and add a disclaimer as suggested by GitHub
debugger22 Jan 7, 2017
353ac74
Merge pull request #37 from debugger22/rebrand
debugger22 Jan 7, 2017
c56cc5d
Fix an alignment issue and reduce header font size
debugger22 Jan 7, 2017
ece54d4
Add btc donate btn
debugger22 Jun 16, 2017
6773ac9
Add a linebreak
debugger22 Jun 16, 2017
3b8272e
Add redis dump to gitignore
OrkoHunter Mar 14, 2019
f0f0935
Add Procfile for heroku
OrkoHunter Mar 14, 2019
65ac7f8
Use Redis addon
OrkoHunter Mar 14, 2019
8d54991
Update gitignore
OrkoHunter Mar 14, 2019
37944ca
Update README with Heroku instructions
OrkoHunter Mar 14, 2019
556096f
Remove DO banner
OrkoHunter Mar 14, 2019
b71849f
Merge pull request #52 from debugger22/heroku
OrkoHunter Mar 14, 2019
d9443fe
docs: fix typo
Jason-Cooke Jun 30, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,8 @@ jspm_packages

# Optional REPL history
.node_repl_history

# Optional for people who uses JetBrains products
*.idea

dump.rdb
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: node server
80 changes: 79 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,80 @@
# github-audio
GitHub Audio
============

Listen to music generated by events happening across GitHub

_Imitation is the sincerest form of flattery._ - __Oscar Wilde__

But seriously, [listen-to-wikipedia](https://github.com/hatnote/listen-to-wikipedia) by [@slaporte](https://github.com/slaporte) and [@mahmoud](https://github.com/mahmoud) is the hotness.

<sub><sup><sub><sup>Use [`ULTIMATE_DREAM_KILLER`](https://github.com/debugger22/github-audio/commit/ed47067f5e56ab70d65fa31f72bf2dbc513f8f56) to filter all events except closed PRs.


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)


# Installing dependencies

This application requires:
* node
* npm
* redis

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

```bash
$ brew install nodejs
$ brew install npm
$ brew install redis
```

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

```bash
$ sudo apt-get update
$ sudo apt-get install nodejs
$ sudo apt-get install npm
$ sudo apt-get install redis-server
```

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

Navigate to the project directory and run

```bash
$ npm install
```

Environment variables
---------------------

```
$ 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 Redis and Server
----------

If you are running locally then run local redis server

```bash
$ redis-server
```

On heroku, you can set up `Heroku Redis` add-on and it sets `REDIS_URL` environment variable.

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

Note: For production run `export NODE_ENV="production"` before starting the server.
137 changes: 137 additions & 0 deletions app/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="title" content="Project Audio for GitHub">
<meta name="description" content="Listen to music generated by events happening across GitHub">
<meta name="keywords" content="github, github music, github events, github visualization, listen, recent changes, sound, music, visualization">
<meta name='summary' content='Events on GitHub, such as pushing commits, creating pull requests, creating issues, etc. are captured and converted to music notes based on the size of the data.'>

<meta name="og:title" content="Project Audio for GitHub">
<meta name="og:url" content="https://github.audio">
<meta name="og:image" content="https://github.audio/static/public/images/electric-guitar.png">
<meta name="og:description" content="Listen to music generated by events happening across GitHub">

<meta name="twitter:card" content="summary" />
<meta name="twitter:site" content="https://github.audio" />
<meta name="twitter:title" content="Project Audio for GitHub" />
<meta name="twitter:description" content="Listen to music generated by events happening across GitHub" />
<meta name="twitter:image" content="https://github.audio/static/public/images/electric-guitar.png" />
<meta name="viewport" content="width=device-width, initial-scale=1">

<meta http-equiv='Expires' content='0'>
<meta http-equiv='Pragma' content='no-cache'>
<meta http-equiv='Cache-Control' content='no-cache'>
<meta http-equiv='imagetoolbar' content='no'>

<title>Project Audio for GitHub</title>
<link rel="mask-icon" href="/static/public/images/electric-guitar.svg" color="orange">
<link rel="shortcut icon" type="image/png" href="/static/public/images/favicon.png"/>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/odometer.js/0.4.7/themes/odometer-theme-default.min.css" />
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/themes/base/jquery-ui.min.css" />
<link rel="stylesheet" href="/static/public/css/main.css"/>
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/jqueryui-touch-punch/0.2.3/jquery.ui.touch-punch.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/howler/2.0.0/howler.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/socket.io/1.4.8/socket.io.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/odometer.js/0.4.7/odometer.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/d3/4.2.6/d3.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/seedrandom/2.4.2/seedrandom.min.js"></script>
<script src="/static/public/js/main.js"></script>
</head>
<body>
<div id="fb-root"></div>
<script>(function(d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
js = d.createElement(s); js.id = id;
js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.7&appId=718063574909410";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>

<header>
<h1 class="header-text">
Project Audio for GitHub&nbsp;
<span class="offline-text">offline</span>
</h1>
<div class="events-remaining">
<span class="events-remaining-value odometer"></span>&nbsp;
<span class="events-remaining-text">events remaining in queue</span>&nbsp;
<div id="volumeSlider"></div>
</div>
</header>

<div id="area">
<div class="online-users-div">
<h2 class="online-users-text"><span class="odometer online-users-count"></span> people listening</h2>
</div>
</div>
<div id="config-area">
<div id="org-repo-filter-div">
Enter your organization's or repository's names to filter events&nbsp; <input type="text" id="org-repo-filter-name" /><br/><br/>
You can also download it for <a href="/static/public/bin/GitHub-Audio-v1.0-macOS-x64.zip" target="_blank">macOS</a> and <a href="/static/public/bin/GitHub-Audio-v1.0-linux-x64.zip" target="_blank">Linux</a>.
</div>
<div class="site-description">
<h4>About</h4>
<br/>
<p>This website tracks events happening across GitHub and converts them to music notes based on certain parameters.</p><br/>
<p>
There are three types of sounds(bell, string pluck and string swell) based on four types of events(PushEvent, PullRequestEvent, IssuesEvent and IssueCommentEvent).
Bells represent PushEvents, string plucks represent IssuesEvents and IssueCommentEvents whereas string swells represent PullRequestEvents.
</p>
</div>
</div>

<footer>
<div class="footer-left-text-block">
<span>Disclaimer: this project is not in any way affiliated with GitHub.</span><br/>
this project is open source, you can view it on <a href="https://github.com/debugger22/github-audio" target="_blank">GitHub</a><br/>
developed by <a href="https://github.com/debugger22" target="_blank">@debugger22</a><br/><br/>
<div id="coinwidget-bitcoin-37XgcaBrHibCMHzvZeZcj5mX5kYn8LUnui"></div><br/>
ProTip: It's actually kind of nice to leave on the background<br/><br/>
</div>
<div class="footer-right-text-block">
inspired by <a href="http://hatnote.com" target="_blank">hatnote</a><br/>
<div>icons made by <a href="http://www.flaticon.com/authors/freepik" target="_blank" title="Freepik">Freepik</a></div>
</div>
<div class="social-buttons">
<a class="twitter-follow-button" data-show-count="false" data-show-screen-name="false" data-size="small" href="https://twitter.com/GithubAudio">Follow</a><br/>
<a href="https://twitter.com/share" class="twitter-share-button" data-show-count="false" data-text="Listen to music generated by events happening across GitHub. #github #music">Tweet</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script><br/>
<div class="fb-share-button" data-href="https://github.audio" data-layout="button" data-size="small" data-mobile-iframe="true"><a class="fb-xfbml-parse-ignore" target="_blank" href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.audio%2F&amp;src=sdkpreparse">Share</a></div>
</div>
</footer>

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-84999786-1', 'auto');
ga('send', 'pageview');
</script>
<script src="//blockr.io/js_external/coinwidget/coin.js"></script>
<script>
CoinWidgetCom.go({
wallet_address: '37XgcaBrHibCMHzvZeZcj5mX5kYn8LUnui',
currency: 'bitcoin',
counter: 'count',
lbl_button: 'Donate',
lbl_count: 'donations',
lbl_amount: 'BTC',
lbl_address: 'Use address below to donate. Thanks!',
qrcode: true,
alignment: 'bl',
decimals: 8,
size: "small",
color: "dark",
countdownFrom: "0",
element: "#coinwidget-bitcoin-37XgcaBrHibCMHzvZeZcj5mX5kYn8LUnui",
onShow: function(){},
onHide: function(){}
});
</script>
</body>
</html>
Binary file added app/public/bin/GitHub-Audio-v1.0-linux-x64.zip
Binary file not shown.
Binary file added app/public/bin/GitHub-Audio-v1.0-macOS-x64.zip
Binary file not shown.
Loading