@bigbinary/neeto-message-templates-frontend 0.0.4

package/README.md

@@ -0,0 +1,196 @@
+# neeto-message-templates
+
+To manage message templates across the neeto products. As of now, it supports
+the creation of SMS, Email and Whatsapp templates.
+
+# Engine Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+    source "NEETO_GEM_SERVER_URL" do
+      # ..existing gems
+
+      gem 'neeto-message-templates-engine'
+    end
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Configure the organization model in the host application.
+
+   ```ruby
+   has_many :message_templates, class_name: "NeetoMessageTemplatesEngine::MessageTemplate", dependent: :destroy
+   ```
+
+4. Add this line to your application's `config/routes.rb` file
+
+   ```ruby
+   mount NeetoMessageTemplatesEngine::Engine => "/neeto_message_templates_engine"
+   ```
+
+5. Copy the migrations from the engine to the host application and run
+   `db:migrate` in host application
+
+   ```shell
+   bundle exec rails neeto_message_templates_engine:install:migrations
+   bundle exec rails db:migrate
+   ```
+
+6. Create a file in the host app under
+   `app/lib/neeto_message_templates_engine/callbacks.rb` & provide the
+   permission (If you don't have permissions, then simply return true)
+
+   ```ruby
+    module NeetoMessageTemplatesEngine
+      class Callbacks
+        def self.can_manage_message_templates?(user)
+          user.has_permission?("admin.manage_message_templates")
+        end
+      end
+    end
+   ```
+
+# Frontend Package Installation
+
+Install the latest `neetoMessageTemplates` package using the below command:
+
+```shell
+yarn add @bigbinary/neeto-message-templates-frontend
+```
+
+## MessageTemplates
+
+### Props
+
+- `shouldIncludeTestTemplate`: A boolean value to determines whether test
+  message template option to be included.
+
+- `handleSubmitTestTemplate`: The function in the host app that handles
+  submitting values to send test templates for email and sms.
+
+- `isTestMessageLoading`: A boolean value that determines whether the test
+  template handle submit is loading or not.
+
+- `type`: Type can be `email`, `sms` or `whatsapp`.
+
+### Usage
+
+```javascript
+import React from "react";
+
+import { MessageTemplates } from "@bigbinary/neeto-message-templates-frontend";
+
+const App = () => {
+  const breadcrumbs = [
+    {
+      link: "/settings",
+      text: "Settings",
+    },
+  ];
+  const handleSubmit = () => {
+    //api call
+  };
+
+  return (
+    <MessageTemplates
+      shouldIncludeTestTemplate
+      breadcrumbs={breadcrumbs}
+      handleSubmitTestTemplate={handleSubmit}
+      isTestMessageLoading={isTestMessageLoading}
+      type={type}
+    />
+  );
+};
+```
+
+## SendMessagePane
+
+### Props
+
+- `isOpen`: To open the side pane.
+
+- `onClose`: To close the side pane.
+
+* `handleSubmit`: The function in the host app which is used to send sms and
+  email.
+
+* `type`: Type can be `email`, `sms` or `whatsapp`.
+
+### Usage
+
+```javascript
+import React, { useState } from "react";
+
+import { SendMessagePane } from "@bigbinary/neeto-message-templates-frontend";
+
+const App = () => {
+  const [isPaneOpen, setIsPaneOpen] = useState(false);
+
+  const handleSubmit = () => {
+    //api call
+  };
+
+  return (
+    <SendMessagePane
+      handleSubmit={handleSubmit}
+      isOpen={isPaneOpen}
+      type={type}
+      onClose={() => setIsPaneOpen(false)}
+    />
+  );
+};
+```
+
+# Development
+
+### Engine
+
+1. Add this line to your application's Gemfile (replace the path to the local
+   copy of neeto-message-templates-engine):
+
+   ```ruby
+   gem 'neeto-message-templates-engine', path: '../neeto-message-templates-engine'
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Refer [engine installation](#engine-installation) steps 3, 4, 5 and 6.
+
+### Frontend Package
+
+The usage of `yalc` is explained in this video:
+https://www.youtube.com/watch?v=QBiYGP0Rhe0
+
+1.  See the changes in the host app by executing the following command \
+     <br/> Use this command if releasing package for the first time.
+
+    ```shell
+    yarn build && yalc publish
+    ```
+
+    Use this command to see changes after the initial publish.
+
+    ```shell
+    yarn release
+    ```
+
+# Setup dummy host app
+
+Setup
+[Instructions](https://github.com/bigbinary/neeto-engineering/tree/main/Local-Development-Setup).
+
+Visit http://spinkart.lvh.me:9014 and login with email `oliver@example.com` and
+password `welcome`.
+
+### Additional Instructions
+
+- Run `yarn build` to bundle the app.