Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bjrmatos/comment
Anonymous comment system using Socket.io, Node.js and React.js
https://github.com/bjrmatos/comment
Last synced: about 1 month ago
JSON representation
Anonymous comment system using Socket.io, Node.js and React.js
- Host: GitHub
- URL: https://github.com/bjrmatos/comment
- Owner: bjrmatos
- License: mit
- Created: 2014-08-24T19:00:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-08-24T18:12:20.000Z (over 10 years ago)
- Last Synced: 2024-10-12T18:08:39.206Z (3 months ago)
- Homepage:
- Size: 977 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Anonymous comment system using Socket.io, Node.js and React.js
--------------
This comment system supports threaded discussions, likes and a simplified login system that uses Twitter API.
It only stores a user id and the avatar's path in a **Redis data store** which allows a user to be anonymous (provided that the user does not share any personal information on his Twitter account).
By default, the app does not record your IP address.
### Requirements
If you haven't installed **Node.js** yet, please refer to [the official documentation](http://nodejs.org/download/).
If you haven't installed **Redis** yet, please refer to [the official documentation](http://redis.io/download).
Once Redis is installed, execute the command `redis-cli` in the command line.
### Installation
Once Node.js and Redis are installed, clone the repo:
```
git clone https://github.com/http-teapot/comment
```
Duplicate `config.dist.js`, name the new file `config.js` and fill out the settings as much as you can.
Most settings will work fine as-is just make sure you specify a domain (can be localhost or 127.0.0.1).
If you didn't set a new app on Twitter (so users can log in), head to the [Twitter's app website](https://apps.twitter.com/), create a new app and check the `API Keys` tab to get the different keys.
Once it's all complete, run:
```
npm start
```
If you want to run your app on port 80, you need to execute the command above as root.
```
sudo npm start
```
### Testing
Once you installed the app, run the following command:
```
npm test
```
### Contributing
Please feel free to contribute to this repository. This software was originally produced as a proof of concept and can definitely be improved.
### Under the MIT license
For more information, refer to the [LICENSE file](https://github.com/http-teapot/comment/blob/master/LICENSE) in this repository.