Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

readme.md

squabble comment server

Build Status Scrutinizer Code Quality

Squabble is a comment server built on Lumen, using a SQLite backend for storing comment data.

It is built for use on http://savaslabs.com although you could easily adapt it for your own site, with a bit of time and server to spare.

Installation for local development

Copy docker-compose.local.example.yml to docker-compose.local.yml. Add overrides for any environment variables which you need to override by copying the defaults set in docker-compose.yml and changing them in your local configuration file.

Run make build to rebuild the container if you've made any changes to Dockerfile or the files in the docker directory.

Run make install

Local development

Run make up.

Edit your /etc/hosts and set 127.0.0.1 local.comments.savaslabs.com. Run curl http://local.comments.savaslabs.com/api/comments to confirm that the server is working; if not, run docker-compose logs -f to see what error messages are appearing.

Testing

make test will run PHPUnit and Behat tests.

API

GET

The following routes are defined:

  • api/comments - Returns an array of all comments stored on the server
  • api/comments/id/{id} - Get a comment by numeric ID
  • api/comments/post/{slug} - Get a comment by the URL of the post it's associated with
  • api/comments/count - Get an array of comment count per posts
  • api/comments/delete/{id}/{token} - Delete a comment by ID, using a unique token for that comment. The token is emailed out when the comment is saved.

POST

The following route is defined:

  • api/comments/new - Save a new comment.

Example POST request:

curl -i -H 'Content-Type: application/json' -XPOST 'http://local.comments.savaslabs.com/api/comments/new' -d '{
    "name": "Some author",
    "email": "a@b.com",
    "comment": "A comment would go here",
    "slug": "2015/04/27/durham-restaurant-time-machine.html",
    "nocaptcha": "owl"
}' 

About

Comment server built with Lumen, for use with static site generators (e.g. Jekyll)

Resources

Packages

No packages published