https://github.com/adhuham/tinycomment
Teeny tiny, easy-to-deploy comment system for static websites.
https://github.com/adhuham/tinycomment
comment-system php static-site static-site-generator
Last synced: 2 months ago
JSON representation
Teeny tiny, easy-to-deploy comment system for static websites.
- Host: GitHub
- URL: https://github.com/adhuham/tinycomment
- Owner: adhuham
- License: gpl-2.0
- Created: 2020-03-16T18:46:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-28T17:22:09.000Z (about 6 years ago)
- Last Synced: 2025-12-27T04:56:18.796Z (6 months ago)
- Topics: comment-system, php, static-site, static-site-generator
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TinyComment
Teeny tiny, easy-to-deploy self-hosted PHP-based comment system for static websites.
# Installation
1) Download the repo and extract it to the root of your website. (eg. https://yourwebsite.com/tinycomment/)
2) Give appropriate permission to the /data/ folder. The user that's running your server process (www-data in Ubuntu/Debian) should be able to Read, Write and Execute in the folder.
You can use the following commands in Ubuntu/Debian based servers.
```bash
cd /path/to/tinycomment/
sudo chown :www-data -R ./data/
sudo chmod g+rwx -R ./data/
```
3) Put the below code snippet to your website:
```html
```
Replace http://yourwebsite.com/tinycomment with the path you extracted the TinyComment in Step 1.
## Deploying to a Sub-Domain
You can also deploy to a subdomain (if you can't do it in your site's root.) In that case replace all the instances of https://yourwebsite.com/tinycomment with your subdomain (eg. https://tinycomment.yourwebsite.com/). Make sure you add appropriate ``Access Control`` headers to your web server's configuration.
# Contribution
TinyComment is in very early stage of development. So any contribution is welcomed; no matter how small it is. But do keep the following in mind while contributing.
1) We want the project to be small, so the number of files should be kept minimal.
2) Any change you bring should not add any extra step for the user in the deployment process. We want the user to be able to just extract the files and get on with it.
3) Use PSR-12 style guidelines.
The todo list below highlights the features we want to be developed.
# Todo
* [ ] Moderation page where the website author can see all the comments and moderate them
* [ ] Reply feature for the comments
* [ ] Option to send email notifications to the website owner once a comment is recieved
* [ ] Option to only allow comments after moderation
* [ ] Ability to add more fields to the comment form (website, email, twitter handle)
# License
Copyright (C) 2020 Mohamed Adhuham
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.