Coder Social home page Coder Social logo

open4comment's Introduction

Open4Comment

This project is abandoned. The code is janky, the architecture suspect, and if you touch it wrong it'll spit XSS at you. It was a neat idea, but for various reasons, I will probably not return to it.

No frills commenting for the your minimalist blog. Like a self-hosted Disqus without all the cruft. Not quite ready for production usage, but getting there.

Features

  • No user login or registration.
  • No upvotes, downvotes, likes, karma or reputation points.
  • No Facebook or Google or Twitter or Github or MySpace or Friendster connect.
  • No discussion threading.
  • Imageboard-inspired tripcodes for those rare occasions when your identity matters on the internet.

Setup

  • git clone https://github.com/dmyates/Open4Comment.git && cd Open4Comment
  • npm install
  • mv config.example.js config.js
  • Setup a separate domain, subdomain or port for your blog's comments (for example, https://comments.example.com for a blog on https://example.com ).
  • Edit config.js to match your site's details. Don't forget to choose your favourite hashing algorithm and a reasonably long salt for tripcode generation!
  • Copy the HTML in client/index.html to where you want comments to go (e.g. if you're using Ghost, post.hbs in your blog's theme).
  • Add client/js/comments.js and client/css/comments.css to your JS and CSS respectively (e.g. if you're using ghost, they go in your blog theme's assets/css and assets/js folders) and link them in where necessary.
  • Customise the look and feel of your comments as much you need to.
  • Finally, run npm start in your Open4Comment directory

You're probably going to want to set up a reverse proxy for serving Open4Comment comments with a proper webserver like nginx.

Todo

  • Currently, Open4Comment assumes (1) you only want comments on blog posts and (2) your post URLs include dates (as is the default setting in Ghost). It will break if you try anything else.
  • Error messages for commenter.
  • Open4Comment should check if a page is open for comment before saving comments for it.
  • Comment moderation.
  • Markdown formatting.

open4comment's People

Contributors

dmyates avatar

Watchers

 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.