{"id":19838687,"url":"https://github.com/thredded/thredded-workgroup","last_synced_at":"2025-10-22T21:46:29.961Z","repository":{"id":38366843,"uuid":"64828883","full_name":"thredded/thredded-workgroup","owner":"thredded","description":"Extension to Thredded with features useful to workgroup messaging (Unread, Unreplied, Following).","archived":false,"fork":false,"pushed_at":"2023-02-19T21:32:42.000Z","size":4189,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-11T19:42:34.949Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thredded.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-03T08:24:47.000Z","updated_at":"2023-01-09T21:56:02.000Z","dependencies_parsed_at":"2024-11-12T12:18:56.653Z","dependency_job_id":"659c488a-1d6a-443c-97ad-47eb31b6e813","html_url":"https://github.com/thredded/thredded-workgroup","commit_stats":{"total_commits":83,"total_committers":3,"mean_commits":"27.666666666666668","dds":0.3614457831325302,"last_synced_commit":"76d52829c170d006b693a6027611284de8aa802c"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thredded%2Fthredded-workgroup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thredded%2Fthredded-workgroup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thredded%2Fthredded-workgroup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thredded%2Fthredded-workgroup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thredded","download_url":"https://codeload.github.com/thredded/thredded-workgroup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241209528,"owners_count":19927734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T12:18:42.391Z","updated_at":"2025-10-22T21:46:24.921Z","avatar_url":"https://github.com/thredded.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Thredded::Workgroup\n\nExtension to [Thredded](http://github.com/thredded/thredded) with features useful to workgroup messaging.\n \nThe point of Thredded-workgroup is to enable migration of workgroup communication from non-shared email to shared opt-in communications -- everyone can see any of the workgroup communications.\n     \noriginated in https://github.com/thredded/thredded/issues/347\n\nOut the box enables a homepage with a top-level nav menu consisting of:\n\n* Unread: a list of unread topics (ordered by last post) across all messageboards\n* Awaiting reply: a list of all topics you follow where yours is the last post\n* Following: a list of followed topics (ordered by last post) across all messageboards\n* All: a list of all topics (ordered by last post) across all messageboards\n* Messageboards: a list of messageboards (as Thredded's normal home page)\n\n![Screenshot of navbar](docs/navbar.png)\n\nIt also shows you the followers of the current topic before you post, and allows you to remove unneeded followers. (The logic for this is that (unlike a social forum) you need to broadcast as little as possible (because the aim is to reduce unnecessary noise, because people can find messages they need to). When you are adding to a topic it may become less relevant to existing followers. The person adding the message is able to adjust followers,\nlike you might adjust the cc-list of conversation).\n     \n![Screenshot of post form](docs/followers-above-post.png)\n\n## Installation\n\nAdd this line to your application's Gemfile (along with thredded if you want to specify a specific fork):\n\n```ruby\ngem 'thredded-workgroup'\n```\n\n### Jquery \n\nSince thredded v0.13.0, thredded doesn't need jquery, but thredded-workgroup (still) does.\nSo you need to include jquery and its ujs file, for example in your Gemfile: \n\n```ruby\ngem \"jquery-rails\"\n```\n \n__NB: (see below for using main branch vs a released version)__\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install thredded-workgroup\n\n## Usage\n\nadd to routes.rb (**instead** of mounting Thredded)\n\n```\n  mount Thredded::Workgroup::Engine =\u003e \"/thredded\"\n```\n\nYou will also need to follow the guidelines for installing Thredded, see https://github\n.com/thredded/thredded#installation.\n\nIf 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:\n\n\n```scss\n@import \"thredded\";\n@import \"thredded-workgroup\";\n```\n\nInclude thredded JavaScripts in your `application.js`:\n\n```js\n//= require thredded\n//= require jquery3  \n//= require jquery_ujs  \n//= require thredded-workgroup\n```\n\n### Configuration\n\n**Reveal on hover?** The last topic shown in the thredded workflow top level pages is by default condensed when too long and revealed by click. You can also have it reveal on hover. This requires adding a data attribute in the layout (e.g. the body, or another high container element), as \u003cdiv data-thredded-condensable-hover=\"reveal\"\u003e. You can preview this behaviour in the demo, by adding `?hover=reveal` to the url.\n\n### View hooks\n\nThredded::Workgroup augments Thredded with some extra view hooks (see https://github.com/thredded/thredded/#view-hooks) for customization.\n\nTo see the extra view hooks provided by Thredded::Workgroup (with their arguments), run:\n\n```bash\ngrep view_hooks -R --include '*.html.erb' \"$(bundle show thredded-workgroup)\"\n```\n\n## Main vs Released versions\n\nNB: if you are using the main branch rather than a release version\n(and as no release has been made yet you must be! :) ) then you may well need\nalso to use the latest main branch of thredded. So your gem file may need to say:\n\n```ruby\n gem 'thredded', github: 'thredded/thredded', branch: 'main'\n gem 'thredded-workgroup', github: 'red56/thredded-workgroup', branch: 'main'\n```\n\nand you need to update both at the same time: `gem update thredded thredded-workgroup`\n\nIn the future we will be releasing thredded-workgroup versions soon after thredded versions.\n\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\nThen create a database and seed it (this is all very similar to Thredded)\n\n```\nbundle exec rake db:create db:migrate db:seed\n```\n\nRun the server\n\n```\nguard\n```\n(you can alternatively run `dummy-rails s -p 3012` but guard runs livereload for you too, which makes development much more pleasant)\n\n### Updating when thredded changes\n\nFor now, there are some copied resources from Thredded. When Thredded changes you need to update these too.\nYou need to have thredded installed with a github reference (check shared.gemfile)\n\nrun `bin/update_from_thredded`\n\n## Contributing\n\nBug 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](http://contributor-covenant.org) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthredded%2Fthredded-workgroup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthredded%2Fthredded-workgroup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthredded%2Fthredded-workgroup/lists"}