Git Product home page Git Product logo

hubbub's Introduction

Hubbub

Comments as Github pull requests for Jekyll (and other static site generator) websites.

Thanks to Miles Sabin (twitter & github) for the original idea and initial sponsorship.

Initial development by Thomas Parslow. Pull requests very welcome.

Build Status

Quick Deployment

You can deploy (for free) to Heroku with the button below:

Deploy

It will ask you for a Github username and a password. This is for the commenter user which will be the user which actually creates the pull requests for comments. I strongly suggest you create a new user just for this.

Manual Deployment

To run the Hubbub server you'll first need to install Node.JS and NPM which you can get nodejs.org.

To install the dependencies required by the Hubbub server run the following command from the project directory:

npm install

You can configure the Hubbub server component by adding a local.json file to the config directory, you can use default.json as a base. You'll need to configure the commenter user (should be a Github user created solely for this purpose) and the target site (you can configure more than one if you want, but you'll usually just want to supply a single default site).

Once you've created the configuration file you can run the server with this command:

PORT=8080 NODE_ENV=local node server.js

Once you've got the server running go to http://127.0.0.1:8080/help to see instructions for integrating Hubbub into your blog (or read the instructions through Github)

Contributing

Pull Requests are very welcome. Check out the Github issues for a list of things that need doing (and please feel free to add your own).

We use Waffle.io to view Github issues, you can too if you want: Stories in Ready

hubbub's People

Contributors

almost avatar milessabin avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.