@bigbinary/neeto-wheel-frontend 1.1.2 → 1.1.3

package/README.md

@@ -1,36 +1,105 @@
 # neeto-wheel-nano
 
-This repo acts as the source of truth for the new nano's structure, configs,
-data etc.
+The `neeto-wheel-nano` acts as the source of truth for the new nano's structure,
+configs, data etc.
 
-# Local Development Setup
+## Contents
 
-1. Setup
-   [Instructions](https://github.com/bigbinary/neeto-engineering/tree/main/Local-Development-Setup).
+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)
 
-2. Run `yarn build` to bundle the app.
+## Development with Host Application
 
-3. Visit http://spinkart.lvh.me:9100 and login with email `oliver@example.com`
-   and password `welcome`.
+### Engine
 
-# Publish instructions
+#### Installation
 
-1. [Engine and package installation](./docs/engine-and-package-installation.md)
-2. [Building and releasing](./docs/building-and-releasing.md)
+1. Add this line to your application's Gemfile:
 
-# Replace NeetoWheelNano with your project name
+   ```ruby
+    source "NEETO_GEM_SERVER_URL" do
+      # ..existing gems
 
-Let's say that the project name is `NeetoBigFish`. Execute the below script to
-replace it.
+      gem 'neeto-wheel-engine'
+    end
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Add this line to your application's `config/routes.rb` file
+
+   ```ruby
+    mount NeetoWheelEngine::Engine => "/neeto_wheel_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_wheel_engine:install:migrations
+   bundle exec rails db:migrate
+   ```
+
+#### Usage
+
+1. Replace NeetoWheelNano 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:
 
-- [Script to replace project name](./docs/replace-project-name-script.md)
+   ```shell
+      ruby script.rb
+   ```
+
+Notes ⚠️
+
+- Don't commit this file.
+- Project name should be given in PascalCase.
+
+### Frontend package
 
-# How to setup neetoCI.
+#### Installation
 
-1. Go to https://neeto-engineering.neetoci.net/projects.
-2. Click `Add new project`.
-3. ```
-    Project name: neeto-wheel-nano
-    Namespace: bigbinary
-    Repository: bigbinary/neeto-wheel-nano
+1. Add the `neeto-wheel-frontend` package to the `package.json`
+
+   ```shell
+   yarn add @bigbinary/neeto-wheel-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-wheel-frontend"
+
+   ```javascript
+   import React from "react";
+
+   import { WelcomeScreen } from "@bigbinary/neeto-wheel-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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-wheel-frontend",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "A repo acts as the source of truth for the new nano's structure, configs, data etc.",
   "license": "UNLICENSED",
   "homepage": "https://github.com/bigbinary/neeto-wheel-nano",
@@ -19,11 +19,14 @@
   "types": "types.d.ts",
   "scripts": {
     "build": "NODE_ENV=production rollup -c --environment production",
+    "build-preview": "NODE_ENV=production webpack",
     "prepare": "husky install",
-    "release": "yarn build && yalc push --sig",
-    "build-preview": "NODE_ENV=production webpack"
+    "release": "yarn build && yalc push --sig"
   },
   "lint-staged": {
+    "./**/*.rb": [
+      "bundle exec rubocop -a --force-exclusion"
+    ],
     "./**/app/javascript/**/*.{js,jsx,json}": [
       "prettier --write",
       "eslint --fix"
@@ -32,43 +35,42 @@
       "prettier --write",
       "eslint --fix"
     ],
-    "./**/*.rb": [
-      "bundle exec rubocop -a --force-exclusion"
-    ],
     "{Gemfile,Rakefile,config.ru}": [
       "bundle exec rubocop -a --force-exclusion"
     ]
   },
   "devDependencies": {
-    "@babel/core": "7.22.6",
-    "@babel/eslint-parser": "7.22.6",
-    "@babel/plugin-transform-runtime": "7.22.6",
-    "@babel/preset-env": "7.22.6",
-    "@babel/preset-react": "7.22.5",
-    "@babel/preset-typescript": "7.22.5",
-    "@babel/runtime": "7.22.6",
-    "@bigbinary/babel-preset-neeto": "1.0.3",
-    "@bigbinary/eslint-plugin-neeto": "1.1.27",
-    "@bigbinary/neeto-audit-frontend": "1.0.8",
-    "@bigbinary/neeto-cist": "1.0.2",
-    "@bigbinary/neeto-commons-frontend": "3.0.1",
-    "@bigbinary/neeto-icons": "1.12.3",
-    "@bigbinary/neeto-molecules": "^1.0.92",
-    "@bigbinary/neetoui": "5.0.13",
+    "@babel/core": "7.23.2",
+    "@babel/eslint-parser": "7.22.15",
+    "@babel/plugin-transform-runtime": "7.23.2",
+    "@babel/preset-env": "7.23.2",
+    "@babel/preset-react": "7.22.15",
+    "@babel/preset-typescript": "7.23.2",
+    "@babel/runtime": "7.23.2",
+    "@bigbinary/babel-preset-neeto": "1.0.6",
+    "@bigbinary/eslint-plugin-neeto": "1.5.0",
+    "@bigbinary/neeto-audit-frontend": "2.0.9",
+    "@bigbinary/neeto-cist": "1.0.8",
+    "@bigbinary/neeto-commons-frontend": "3.1.20",
+    "@bigbinary/neeto-filters-frontend": "3.1.3",
+    "@bigbinary/neeto-icons": "1.17.14",
+    "@bigbinary/neeto-molecules": "1.13.6",
+    "@bigbinary/neetoui": "6.3.3",
     "@emotion/is-prop-valid": "1.2.0",
-    "@faker-js/faker": "8.0.2",
-    "@honeybadger-io/react": "2.0.1",
-    "@rollup/plugin-alias": "5.0.0",
-    "@rollup/plugin-babel": "6.0.3",
-    "@rollup/plugin-commonjs": "25.0.2",
-    "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.1.0",
-    "@rollup/plugin-replace": "5.0.2",
-    "@svgr/rollup": "8.0.1",
-    "antd": "4.24.12",
-    "autoprefixer": "10.4.14",
-    "axios": "1.4.0",
-    "babel-loader": "9.1.2",
+    "@faker-js/faker": "8.2.0",
+    "@honeybadger-io/js": "6.5.3",
+    "@honeybadger-io/react": "6.1.9",
+    "@rollup/plugin-alias": "5.0.1",
+    "@rollup/plugin-babel": "6.0.4",
+    "@rollup/plugin-commonjs": "25.0.7",
+    "@rollup/plugin-json": "6.0.1",
+    "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-replace": "5.0.4",
+    "@svgr/rollup": "8.1.0",
+    "antd": "5.10.2",
+    "autoprefixer": "10.4.16",
+    "axios": "1.6.0",
+    "babel-loader": "9.1.3",
     "babel-plugin-istanbul": "6.1.1",
     "babel-plugin-js-logger": "1.0.17",
     "babel-plugin-macros": "3.1.0",
@@ -83,28 +85,28 @@
     "css-loader": "6.8.1",
     "dompurify": "3.0.2",
     "dotenv-webpack": "^8.0.1",
-    "eslint": "8.44.0",
-    "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-cypress": "2.13.3",
-    "eslint-plugin-import": "2.27.5",
+    "eslint": "8.52.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-cypress": "2.15.1",
+    "eslint-plugin-import": "2.29.0",
     "eslint-plugin-jam3": "0.2.3",
     "eslint-plugin-json": "3.1.0",
-    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",
     "eslint-plugin-security": "^1.7.1",
     "eslint-plugin-sonarjs": "^0.21.0",
-    "eslint-plugin-unused-imports": "2.0.0",
+    "eslint-plugin-unused-imports": "3.0.0",
     "eslint-plugin-xss": "^0.1.12",
-    "formik": "2.4.2",
+    "formik": "2.4.5",
     "html-webpack-plugin": "5.5.3",
     "https-browserify": "1.0.0",
     "husky": "8.0.3",
-    "i18next": "23.2.7",
+    "i18next": "23.6.0",
     "i18next-browser-languagedetector": "7.0.1",
     "js-logger": "1.6.1",
-    "lint-staged": "13.2.3",
+    "lint-staged": "15.0.2",
     "mini-css-extract-plugin": "2.7.6",
     "mixpanel-browser": "2.47.0",
     "os-browserify": "0.3.0",
@@ -112,31 +114,33 @@
     "postcss": "8.4.31",
     "postcss-import": "15.1.0",
     "postcss-loader": "7.3.3",
-    "postcss-preset-env": "9.0.0",
-    "prettier": "2.8.8",
-    "prettier-plugin-tailwindcss": "0.3.0",
+    "postcss-preset-env": "9.2.0",
+    "prettier": "2.6.2",
+    "prettier-plugin-tailwindcss": "0.1.10",
     "process": "0.11.10",
-    "ramda": "0.29.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+    "qs": "6.11.2",
+    "ramda": "0.29.1",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
     "react-helmet": "6.1.0",
-    "react-i18next": "13.0.1",
+    "react-i18next": "13.3.1",
     "react-query": "3.39.3",
-    "react-router-dom": "5.3.3",
-    "react-toastify": "8.0.2",
+    "react-router-dom": "5.3.4",
+    "react-toastify": "8.2.0",
     "react_ujs": "^3.1.1",
     "rollup": "2.79.1",
     "rollup-plugin-analyzer": "4.0.0",
     "rollup-plugin-cleaner": "1.0.0",
+    "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-peer-deps-external": "2.2.4",
     "rollup-plugin-styles": "4.0.0",
-    "sass": "1.63.6",
+    "sass": "1.69.5",
     "sass-loader": "13.3.2",
     "shakapacker": "6.6.0",
     "stream-browserify": "3.0.0",
     "stream-http": "3.2.0",
     "style-loader": "3.3.3",
-    "tailwindcss": "npm:@tailwindcss/postcss7-compat",
+    "tailwindcss": "3.4.1",
     "tty-browserify": "0.0.1",
     "url": "0.11.1",
     "util": "0.12.5",
@@ -145,30 +149,32 @@
     "webpack-assets-manifest": "5.1.0",
     "webpack-cli": "5.1.4",
     "webpack-dev-server": "4.15.1",
-    "yup": "0.32.11"
+    "yup": "1.3.2"
   },
   "peerDependencies": {
     "@bigbinary/neeto-cist": "latest",
-    "@bigbinary/neeto-commons-frontend": "^2.1.28",
+    "@bigbinary/neeto-commons-frontend": "3.1.20",
     "@bigbinary/neeto-editor": "^1.26.3",
-    "@bigbinary/neeto-icons": "^1.9.22",
-    "@bigbinary/neeto-molecules": "^1.0.9",
-    "@bigbinary/neetoui": "^4.4.10",
-    "@honeybadger-io/react": "^2.0.1",
-    "axios": "^0.27.2",
+    "@bigbinary/neeto-filters-frontend": "3.1.3",
+    "@bigbinary/neeto-icons": "1.17.14",
+    "@bigbinary/neeto-molecules": "1.13.6",
+    "@bigbinary/neetoui": "6.3.3",
+    "@honeybadger-io/js": "^6.5.3",
+    "@honeybadger-io/react": "^6.1.9",
+    "axios": "^1.6.0",
     "classnames": "^2.3.2",
-    "formik": "^2.2.9",
-    "i18next": "23.2.7",
+    "formik": "^2.4.5",
+    "i18next": "^23.6.0",
     "js-logger": "^1.6.1",
     "mixpanel-browser": "^2.45.0",
-    "ramda": "^0.29.0",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
+    "ramda": "^0.29.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-helmet": "^6.1.0",
-    "react-i18next": "13.0.1",
-    "react-query": "3.39.2",
-    "react-router-dom": "5.3.3",
-    "react-toastify": "8.2.0",
+    "react-i18next": "^13.3.1",
+    "react-query": "^3.39.3",
+    "react-router-dom": "^5.3.4",
+    "react-toastify": "^8.2.0",
     "yup": "^0.32.11",
     "zustand": "4.3.2"
   },