https://github.com/drewml/hipchat-code-snippets

A HipChat Connect Integration that enables users to post snippets of code that will be displayed with proper syntax highlighting
https://github.com/drewml/hipchat-code-snippets

Last synced: about 1 year ago
JSON representation

A HipChat Connect Integration that enables users to post snippets of code that will be displayed with proper syntax highlighting

• Host: GitHub
• URL: https://github.com/drewml/hipchat-code-snippets
• Owner: DrewML
• Created: 2015-11-20T01:52:42.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-25T05:33:15.000Z (over 10 years ago)
• Last Synced: 2025-02-01T22:29:08.243Z (over 1 year ago)
• Language: JavaScript
• Size: 341 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# HipChat Code Snippets

![ScreenShot 1](screenshots/post.png)

![ScreenShot 2](screenshots/notification.png)

![ScreenShot 3](screenshots/view.png)

## Technology Stack

- [Express 4](http://expressjs.com/api.html)

- [Redis](http://redis.io/)

- [Babel](https://babeljs.io/)

- [Rollup](http://rollupjs.org/)

## How it Works

When in a chatroom that has the integration installed, users can select the `Post Code Snippet` action. When the user chooses to `Post Snippet`, the following happens:

1. The code is used to create a private GitHub Gist

2. A notification in the chatroom is sent, notifying users of the new snippet

3. Users can click on the notification, which will open a modal with the contents of the private Gist

## Running Locally

**Prerequisites**

- Must be using a version of `node.js` > 5.0.0

- Must have Redis server running locally

### Setup/Configuration

1. Clone the repository

2. Run `npm install` in the root of the repo

3. Setup [ngrok](https://ngrok.com/) (or another local tunnel) to listen on port `3000`

4. Open `config.json`, and change the `localBaseUrl` value to the hostname provided by `ngrok`

5. Run `npm start`, which will build all assets and start the Integration's server

### Installing in HipChat

1. Open up one of your HipChat rooms in the `4.0.x` client, and click `Configure Integrations`

2. Scroll to the bottom of the Integrations page that opened, and click `Install an integration from a descriptor URL`

3. Select the room(s) you wish to install this integration for

## Deploying to a SaaS or PaaS Host

*Coming Soon...*