@bigbinary/neeto-redirect-urls-frontend 2.1.1

package/README.md

@@ -0,0 +1,105 @@
+# neeto-redirect-urls-nano-nano
+
+The `neeto-redirect-urls-nano-nano` acts as the source of truth for the new nano's structure,
+configs, data etc.
+
+## Contents
+
+1. [Development with Host Application](#development-with-host-application)
+   - [Engine](#engine)
+     - [Installation](#installation)
+     - [Usage](#usage)
+   - [Frontend package](#frontend-package)
+     - [Installation](#installation-1)
+     - [Instructions for development](#instructions-for-development)
+     - [Usage](#usage-1)
+2. [Instructions for Publishing](#instructions-for-publishing)
+
+## Development with Host Application
+
+### Engine
+
+#### Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+    source "NEETO_GEM_SERVER_URL" do
+      # ..existing gems
+
+      gem 'neeto-redirect-urls-engine'
+    end
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Add this line to your application's `config/routes.rb` file
+
+   ```ruby
+    mount NeetoRedirectUrlsEngine::Engine => "/neeto_redirect_urls_engine"
+   ```
+
+4. Add required migrations in the `db/migrate` folder. Run the following
+   commands to copy the migrations from the engine to the host application.
+
+   ```shell
+   bundle exec rails neeto_redirect_urls_engine:install:migrations
+   bundle exec rails db:migrate
+   ```
+
+#### Usage
+
+1. Replace NeetoRedirectUrlsNanoNano with your project name
+
+   Create a `script.rb` file in the project root and paste the script from the
+   following file.
+
+   [Replace project name script](./docs/engine/replace-project-name-script.md)
+
+2. Run the file using the following command:
+
+   ```shell
+      ruby script.rb
+   ```
+
+Notes ⚠️
+
+- Don't commit this file.
+- Project name should be given in PascalCase.
+
+### Frontend package
+
+#### Installation
+
+1. Add the `neeto-redirect-urls-frontend` package to the `package.json`
+
+   ```shell
+   yarn add @bigbinary/neeto-redirect-urls-frontend
+   ```
+
+### Instructions for development
+Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step instructions to develop the frontend package.
+
+#### Usage
+
+1. Import `WelcomeScreen` component from "@bigbinary/neeto-redirect-urls-frontend"
+
+   ```javascript
+   import React from "react";
+
+   import { WelcomeScreen } from "@bigbinary/neeto-redirect-urls-frontend";
+
+   const App = () => <WelcomeScreen />;
+
+   export default App;
+   ```
+
+## Instructions for Publishing
+
+Consult the
+[building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages)
+guide for details on how to publish.

package/app/javascript/src/translations/en.json

@@ -0,0 +1,54 @@
+{
+  "neetoRedirectUrls": {
+    "titles": {
+      "dashboard": "Dashboard"
+    },
+    "common": {
+      "delete": "Delete",
+      "edit": "Edit",
+      "placeholder": {
+        "relativeUrl": "/articles/welcome",
+        "url": "https://example.com"
+      }
+    },
+    "settings": {
+      "title": "Settings",
+      "redirecturl": {
+        "title": "Redirect URLs",
+        "description": "View and manage redirect URLs"
+      },
+      "general": {
+        "title": "General"
+      }
+    },
+    "emptyState": {
+      "redirectURLs": {
+        "title": "There are no redirect URLs to show.",
+        "description": "Here is how you can create <helpLink>redirect URLs</helpLink>."
+      }
+    },
+    "alerts": {
+      "delete": {
+        "title": "Delete redirect URL?",
+        "confirm": "You are permanently deleting the redirection from <strong>{{ from_path }}</strong> to <strong>{{ to_path }}</strong>. This can't  be undone."
+      }
+    },
+    "redirect": {
+      "source": "Source",
+      "destination": "Destination",
+      "add": "Add new redirect URL",
+      "edit": "Edit redirect URL",
+      "search": "Search Redirect URL",
+      "domainLevelRedirect": {
+        "label": "Add domain level redirection",
+        "description": "This feature allows you to redirect all your course URLs from neetoCourse to a new domain. <Link>View help article</Link> for more information."
+      },
+      "validations": {
+        "source": "Source path must be valid",
+        "destination": "Destination url must be valid",
+        "required": "{{entity}} is required",
+        "duplicateDomain": "Cannot use same domain for redirection"
+      }
+    }
+  }
+}

package/app/javascript/src/translations/index.js

@@ -0,0 +1,3 @@
+import en from "./en.json";
+
+export { en };