https://github.com/eradman/sidecomment

Select Text, Submit Comments
https://github.com/eradman/sidecomment

Last synced: about 1 month ago
JSON representation

Select Text, Submit Comments

• Host: GitHub
• URL: https://github.com/eradman/sidecomment
• Owner: eradman
• License: other
• Created: 2023-11-18T02:12:48.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-09-05T00:23:21.000Z (2 months ago)
• Last Synced: 2024-09-07T07:12:10.465Z (2 months ago)
• Language: Ruby
• Size: 81.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Sources for sidecomment.io

==========================

_Select Text, Submit Comments_

Design Goals

------------

Constraints

* Minimal overhead to page load times

* Must not conflict with namespaces

* Must cooperate with each site's CSS

* No local storage or cookies

Authorization

* Lazy signup, no password

* Anonymous; only a valid e-mail

* Rate limit e-mail (per minute and per hour) to avoid abuse

Requirements

------------

Runtime: ruby postgresql-server

Test: ephemeralpg chromium node

Installation

------------

    bundle install

    npm install

Database Initialization

-----------------------

Reset everything

    dropdb sidecomment

Initialize database

    psql -f schema/roles.sql

    psql -c 'CREATE DATABASE sidecomment OWNER sidecomment;'

    psql -c 'ALTER USER sidecomment SUPERUSER;'

    for f in schema/??-*.sql; do

        psql -q -U sidecomment -f $f

    done

    psql -c 'ALTER USER sidecomment NOSUPERUSER;'

Optionally load test data

    psql -U sidecomment -f server_tests/data.sql

Archiving

---------

sidecomment.io preserves a little data as possible.  `cron` or the `pg_cron`

extension can be used to archive records and summarize results

    CALL prune_usercodes('30 days'::interval);

    CALL archive_tickets('30 days'::interval);

History

-------

See [TIMELINE.md](TIMELINE.md) for the history of this project.

Source code for `sidecomment.io` is licensed under an ISC-style license.

Copyright 2021 Eric Radman / Ratical Software.