Giter VIP home page Giter VIP logo

comments's Introduction

comments.

still under work, feel free to fork. Pull requests are welcome.

A FREE/Libre commenting engine that is lightweight, serverless, and possibly doesn't requires wonky workarounds.

guycomputer

How it works

This engine is NOT fully automated. It relies on the site owner to do some manual work, but this was the only way to make sure that it stayed lightweight, and serverless.

There are two ways it can work:

Manual E-mails

The site owner creates a comment entry form and puts it in the pages where they want the comments to be shown. A sample is shown in sample.html file.

This way relies on the site visitors to E-mail the comment to the site owner. Whenever a user enters a comment in the comment box and clicks submit, it will open a pop up, asking the user to open their mail client with a pre-formatted message to the site owner. The user has to click OK and send.

If the user chooses to not open their mail client or they don't have one, the pre-formatted message will be copied to their clipboard which they can send manually to the site owner.

Once the site owner receives the message, which has a javascript object, they can paste that object in the comments-data.js file and rebuild their site. The comments will show up on the specified page.

Pastebin (WIP)

This process is similar to the Manual one, except here the user doesn't have to do anything. They press the submit button and the program will send the data to a paste page url provided by the site owner. The paste page will also be made by me and added here later. This method is still a WIP.

Although this method won't be truly serverless.

Dependencies

This software requires showdownjs to convert markdown comments into html. You can ignore this if you don't want markdown support. It also requires jquery.

Install

1. Make sure all dependencies are linked in the head or foot of your page.
2. Link comments.js and comments-data.js in your page.
3. Change the config variables in comments.js according to your needs.
4. Add the sample.html or equivalent code in your page.

comments's People

Contributors

gtlsgamr avatar

Stargazers

 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.