Thredded::Workgroup

Extension to Thredded with features useful to workgroup messaging (Unread, Unreplied, Following).

originated in https://github.com/thredded/thredded/issues/347

Out the box enables a homepage with a top-level nav menu consisting of:

  • Unread: a list of unread topics (ordered by last post) across all messageboards
  • Following: a list of followed topics (ordered by last post) across all messageboards
  • Awaiting reply: a list of all topics you follow where yours is the last post
  • All topics: a list of all topics (ordered by last post) across all messageboards
  • All messageboards: a list of messageboards (as present)

It adds a navbar like this:

screenshot

Installation

Add this line to your application's Gemfile (along with thredded if you want to specify a specific fork):

gem 'thredded-workgroup'

Jquery

Since thredded v0.13.0, thredded doesn't need jquery, but thredded-workgroup (still) does. So you need to include jquery and its ujs file, for example in your Gemfile: 

gem "jquery-rails"

NB: (see below for using master vs a released version)

And then execute:

$ bundle

Or install it yourself as:

$ gem install thredded-workgroup

Usage

add to routes.rb (instead of mounting Thredded)

  mount Thredded::Workgroup::Engine => "/thredded"

You will also need to follow the guidelines for installing Thredded, see https://github .com/thredded/thredded#installation.

If you use an application layout (see Add thredded styles to your application.scss (see https://github.com/thredded/thredded#application-layout) below for customizing the styles), you will need to include thredded and thredded-workgroup:

@import "thredded";
@import "thredded-workgroup";

Include thredded JavaScripts in your application.js:

//= require thredded
//= require jquery3  
//= require jquery_ujs  
//= require thredded-workgroup

Master vs Released versions

NB: if you are using the master version rather than a release version (and as no release has been made yet you must be! :) ) then you may well need also to use the latest master release of thredded. So your gem file may need to say:

 gem 'thredded', github: 'thredded/thredded', branch: 'master'
 gem 'thredded-workgroup', github: 'red56/thredded-workgroup', branch: 'master'

and you need to update both at the same time: gem update thredded thredded-workgroup

In the future we will be releasing thredded-workgroup versions soon after thredded versions.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Then create a database and seed it (this is all very similar to Thredded)

bundle exec rake db:create db:migrate db:seed

Run the server

dummy-rails s -p 3012

Updating when thredded changes

For now, there are some copied resources from Thredded. When Thredded changes you need to update these too. You need to have thredded installed with a github reference (check shared.gemfile)

run bin/update_from_thredded

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/red56/thredded-workgroup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.