Code Monkey home page Code Monkey logo

retort's Introduction

Retort - A Reaction Plugin for Discourse

Retort allows you and your users to add slack-style reactions to your discourse posts.

Check out a quick gif of it in action here!

Installation

You're done!

Limiting the possible emoji set

Some communities will want to limit the possible reactions to just a few, rather than all possible emojis. Retort now supports this!

limited reactions

In order to use a limited emoji set, simply visit admin/site_settings/category/plugins, and check the box which says 'Constrain the list of reactions to the list specified below'.

admin_panel

Then, enter the list of emojis you'd like to support, delimited by the '|' character. (So, for example, if you only wanted to support thumbs up / thumbs down reactions, you'd put in +1|-1)

Feel free to style elements underneath the .retort-picker class in Admin > Customize > HTML/CSS, if you need further customizations like emoji size, spacing, etc.

Limiting the number of reactions per post

There's an additional site setting, 'retort allow multiple reactions', which determines whether users can react to a single post multiple times or not. (It is enabled by default). If you only want users to be able to create one reaction per post (if you're using Retort as a voting system, for example), set this option to false.

Disabling retort for particular categories

The 'retort disabled categories' site setting allows disabling particular reacting in particular categories by name. These category names are case-insensitive.

For example, entering staff|announcements into this field will disallow all users from reacting to topics in the categories name 'Staff' or 'Announcements'.

Contributing

Pull requests welcome! To contribute:

  • [Fork it] (../../fork )
  • Create your feature branch (git checkout -b your-new-feature)
  • Commit your changes (git commit -am 'Add some feature)
  • Push to the branch (git push origin your-new-feature)
  • Create a new Pull Request

retort's People

Contributors

gdpelican avatar angusmcleod avatar schungx avatar rizka10 avatar aveybd avatar alfonsomunozpomer avatar cfstras avatar davidgnavas avatar dtraleigh avatar r-zander avatar yiabiten avatar lze3 avatar jbrw avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.