Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

GitChat - simple chat application build on top of GitHub APIs.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 configs
Octocat-spinner-32 public
Octocat-spinner-32 styls
Octocat-spinner-32 views
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
Octocat-spinner-32 server.js
README.md

gitchat

Chat application build on top of GitHub API. It was build in 24 hours during Berlin LinkedIn

Hackathon (October 2012).

We are using GitHub Issues API and web hooks.

After receiving webhook server code will broacast message to other people in the room.

Protocol

Protocol is super simple:

  • github issue is a room.
  • github issue comment is a message inside the room.

Tools

Build using Node.js, Socket.io, jQuery. Hosted on nodejitsu.

Demo

Checkout this link for chat room of hackers.

Or you can try it by downloading code locally and running it with following commands:

 npm install
 node server.js

Then just open http://localhost:3000/ in your browser.

Note that real-time updates will not work since web hooks will not work with local servers.

Features

Thich chat app has following cool features:

  • desktop notifications
  • email notifications
  • real-time updates (you get all new messages in room immediately)
  • multiple rooms support
  • unlimited amount of users inside the room
  • private rooms support (just create an issue in private repository)

How to

To create new chat room just create some issue in your own repostory. Then just type following url in browser:

  http://gitchat.jit.su/room/#{USER_NAME}/#{REPO_NAME}}/#{ISSUE_ID}

where:

  • #{USER_NAME} - username of orgnisation name that holds the GitHub repo where you created issue.
  • #{REPO_NAME} - GitHub repo name where you created issue.
  • #{ISSUE_ID} - id of issue you just created on GitHub. It's the last token of URL for that issue.

License

(The MIT License)

Copyright © 2013 Hashobject Ltd (team@hashobject.com).

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.