Skip to content

Commit

Permalink
Release HangHub.
Browse files Browse the repository at this point in the history
  • Loading branch information
elszczepano committed May 21, 2019
0 parents commit 6657489
Show file tree
Hide file tree
Showing 20 changed files with 1,737 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Configurations to normalize the IDE behavior.
# http://editorconfig.org/

root = true

[*]
indent_style = tab
tab_width = 4
charset = utf-8
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true

[{*.json,.*}]
indent_style = space
tab_width = 2
20 changes: 20 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/**
* @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
* This file is licensed under the terms of the MIT License (see LICENSE.md).
*/

/* eslint-env node */

module.exports = {
extends: "ckeditor5",
env: {
"browser": true,
"webextensions": true
},
rules: {
'max-len': 'off'
},
parserOptions: {
ecmaVersion: 2018,
}
};
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules/
.idea/
package-lock.json
frontend/build/
13 changes: 13 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Software License Agreement
==========================

**HangHub** - https://github.com/ckeditor/hanghub <br>
Copyright (c) 2003-2019, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.

Licensed under the terms of the MIT License

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.
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# HangHub

HangHub is a productivity tool that allows you to see users who are working on the same GitHub issue as you. It gives information in real time about whether they are:

* viewing 👀
* commenting ✍
* merging 🔀
* idle 💨

You can activate HangHub for a specific organization or a repository of your choice.

HangHub was created with ❤️ by [CKEditor team](https://ckeditor.com/). We created HangHub out of our own struggles with GitHub, spending time on the same issues without knowing our teammate was also doing the exact same thing. With HangHub we hope to save your and your teammates’ time and help your productivity!

## Usage

### Use the official browser extension

HangHub is available as a browser extension in Chrome web store and Firefox Add-ons.

### Build your own version

You are most welcome to modify the plugin and build your custom version. We will be happy to see pull requests with plugin enhancements, too!

#### 1. Clone

```
git clone https://github.com/ckeditor/hanghub.git
```

#### 2. Install and build

```
cd hanghub/frontend
npm i
npm run build
```

#### 3. Add the plugin to Google Chrome

* Navigate to `chrome://extensions`.
* Switch on "Developer mode".
* Click "Load unpacked".
* Navigate to the the `hanghub/frontend/build` directory containing the extension code and submit.

#### 4. Add the plugin to Mozilla Firefox

* Navigate to `about:debugging`.
* Click "Load Temporary Add-on...".
* Navigate to the `hanghub/frontend/build` directory and open the `manifest.json` file.

### Use your own server

HangHub backend is free to use. But if you feel better with your own backend server, you can also use it. Assuming that you have already cloned the HangHub project, you need to proceed as follows.

#### 1. Install and build

```
cd hanghub/backend
npm i
```

#### 2. Deploy

Deploy the content of the `backend` directory to your server.

#### 3. Change the `SOCKET_URL`

You now need to replace the `SOCKET_URL` in `frontend/src/index.js` and add it to the `frontend/manifest.json` file in the `permissions` array. After that, rebuild the frontend part of the project using `npm run build`.

## License

Licensed under the terms of the [MIT](http://en.wikipedia.org/wiki/MIT_License) license. For full details about the license, please check the `LICENSE.md` file.
18 changes: 18 additions & 0 deletions backend/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "HangHub-backend",
"version": "1.0.0",
"description": "",
"main": "src/index.js",
"scripts": {
"start": "node src/index.js",
"lint": "eslint ./src"
},
"author": "CKSource (http://cksource.com/)",
"license": "MIT",
"dependencies": {
"eslint": "^5.16.0",
"eslint-config-ckeditor5": "^1.0.14",
"express": "^4.16.4",
"socket.io": "^2.2.0"
}
}
Loading

0 comments on commit 6657489

Please sign in to comment.