Skip to content

fondation-unit/messaging

Repository files navigation

Messaging

A simple User <=> Institution messaging engine.

Installation

Add this line to your application's Gemfile:

gem "messaging", git: "https://github.com/fondation-unit/messaging"

And then execute:

$ bundle

Create the migration files:

$ bin/rails messaging:install:migrations

Copy the views and config files:

$ bin/rails generate messaging:install

Mount the engine in config/routes.rb:

mount Messaging::Engine, at: "/messaging"

Set the config variables in config/initializers/messaging.rb.

Example :

# frozen_string_literal: true

Messaging.configure do |config|
  config.notification_channel = "notification_channel"
  config.notification_target = "notifications-count"
  config.notification_count_method = "unread_notifications_count"
  config.user_class = "User"
  config.institution_class = "Institution"
end

Assets

Compile the assets :

$ bin/rails app:assets:precompile

Within your main application, add the following in app/config/manifest.js :

//= link messaging/application.js