Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sylque/docuss
A comment/discussion/collaboration system for websites and web apps
https://github.com/sylque/docuss
Last synced: about 1 month ago
JSON representation
A comment/discussion/collaboration system for websites and web apps
- Host: GitHub
- URL: https://github.com/sylque/docuss
- Owner: sylque
- License: mit
- Created: 2018-08-18T09:56:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-04T09:07:51.000Z (almost 3 years ago)
- Last Synced: 2024-07-26T12:45:09.578Z (5 months ago)
- Language: CSS
- Homepage:
- Size: 332 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - sylque/docuss - A comment/discussion/collaboration system for websites and web apps (others)
README
# Docuss
A comment/discussion/collaboration system for websites and web apps.
> ### **This project is not active anymore**.
> You might want to check [DiscPage](https://github.com/sylque/discpage), which shares a lot of features with Docuss.
## Features
- Add comments **or full discussion topics** to your web pages
- Create **menus or buttons with attached comments/discussions**
- Supports Wordpress out of the box
## Live Demo
- ~~**Mustacchio**: a fake website demonstrating most Docuss features~~
## Other Demos
- ~~**WorDPress**: a fake Wordpress blog, with comments added to Post headings and discussions added to Pages.~~
- ~~**OpenStack**: a single page from a live\* website, with discussions added to each heading~~
- ~~**Discuss The Web**: a sample Meteor+React web app.~~
## How It Works
Docuss allows to integrate your website (or web app) with
[Discourse](https://www.discourse.org/), the popular open-source discussion
platform. Docuss is composed of a plugin running in your Discourse forum and a
JavaScript library running in your web pages.
## Project Status
Docuss is in prototype phase. Please report any idea or issue in the above
`Issues` tab.
# How To Use It
## "I just want to see if it really works"
1. Set up your [Discourse](https://www.discourse.org/) instance (see the
installation manual
[here](https://github.com/discourse/discourse/blob/master/docs/INSTALL.md))
with SSL (see SSL setup [here](https://meta.discourse.org/t/how-to-set-up-ssl-in-discourse/56577)).
2. Install the [Docuss plugin](https://github.com/sylque/dcs-discourse-plugin)
in your Discourse instance, and set it up with this JSON description file:
`https://sylque.github.io/dcs-client/demos/mustacchio/dcs-website.json`
3. You should see the _Mustacchio_ demo running smoothly within your Discourse
instance (with the exception of the menu bar, as explained
[here](https://github.com/sylque/dcs-discourse-plugin#website-navigation))
## "I'm convinced, I want to integrate my website"
You will need:
- A server running a [Discourse](https://www.discourse.org/) instance (see the
installation manual
[here](https://github.com/discourse/discourse/blob/master/docs/INSTALL.md)).
- A server hosting your website or web app.
Docuss installation:
1. Add a [Docuss client library](https://github.com/sylque/dcs-client) to your
website pages (if your website is a Wordpress blog, this can be done
automatically for you by the
[dcs-wordpress-plugin](https://github.com/sylque/dcs-wordpress-plugin)).
2. Create a
[JSON description file](https://github.com/sylque/dcs-website-schema) and
host it alongside your website.
3. Install the [Docuss plugin](https://github.com/sylque/dcs-discourse-plugin)
in your Discourse instance and set it up with your JSON description file.
# License
All Docuss components are released under the [MIT](LICENSE) license.
---
\* _Demos targeting live websites use a specific
proxy server to inject a Docuss client library into pages. This proxy is not
available yet._