@bigbinary/neeto-folders-frontend 1.1.0

package/README.md

@@ -0,0 +1,105 @@
+# neeto-folders-nano
+
+The `neeto-folders-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-folders-engine'
+    end
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Add this line to your application's `config/routes.rb` file
+
+   ```ruby
+    mount NeetoFoldersEngine::Engine => "/neeto_folders_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_folders_engine:install:migrations
+   bundle exec rails db:migrate
+   ```
+
+#### Usage
+
+1. Replace NeetoFoldersNano 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-folders-frontend` package to the `package.json`
+
+   ```shell
+   yarn add @bigbinary/neeto-folders-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-folders-frontend"
+
+   ```javascript
+   import React from "react";
+
+   import { WelcomeScreen } from "@bigbinary/neeto-folders-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,36 @@
+{
+  "common": {
+    "cancel": "Cancel",
+    "delete": "Delete",
+    "edit": "Edit",
+    "move": "Move",
+    "save": "Save",
+    "items": "Items"
+  },
+  "createFolder": {
+    "parentInfo": "Leave the option empty to create folder at the root level",
+    "parentTitle": "Parent folder"
+  },
+  "deleteFolder": {
+    "info": "Are you sure you want to delete the folder <strong>{{name, anyCase}}</strong>?",
+    "title": "Delete folder"
+  },
+  "folders": {
+    "title": "Folders",
+    "add": "Add new folder",
+    "edit": "Edit folder",
+    "name": "Folder name",
+    "subfolderCount_one": "{{count}} sub folder",
+    "subfolderCount_other": "{{count}} sub folders",
+    "noFolders": "No folders to show"
+  },
+  "moveToFolder": {
+    "depthExceeded": "Cannot move to this folder. Maximum {{maxDepth}} nested folders are allowed.",
+    "notAllowed": "You cannot move to this folder.",
+    "remove": "Remove from folder",
+    "title": "Move to folder"
+  },
+  "reorderFolder": {
+    "title": "Reorder folders"
+  }
+}

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

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