...
Task:
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Outline:
We need to make a new shopify plugin for Netcomm. This plugin will be copy of their old plugin. Here are the feature list of old plugins:
eKomi Official Shopify Plugin for NetComm
...
Summary:
...
Shopify install → This is broken down into a number of steps:
DB configuration - new table / entity.
Shopify App Admin config → add apps nav uri’s.
Main Dev steps:
...
Request from shopify to the app with the hmac and shop.
The app recodes and removes the hmac value, sends authorization request with shop api key or client id and with the redirect url. Then it redirects with callback.
...
Request from shopify with callback while process is still actually in the install method.
app parses request in callback action method, creates a request to shopify to get the access token.
Then the app registers the un-install webhook.
...
Then upon success the app should return the application settings form.
This is where the NetcommId and eKomi details are captured.
Form then validates & saves.
...
Check from start to finish.
...
This plugin will be made with new Shopify Designs (please check eKomi Plugins for reference ) .
Overview:
The plugin will run from the Plugin Dashboard system and serve Shopify as an API.
Research is required to implement the new generation of Shopify plugin which is an Embedded App.
The embedded app is served within the Shopify Admin Dashboard.
The app will provide installation and uninstallation functionality.
The main requirement within the app is to capture Netcomm and or eKomi configuration settings and persist that to a DB.
Affected Resources:
Netcomm and eKomi plugins. Shopify is changing and it will affect our future plugins.
Plugin Dashboard DB schema will be changed and a new table introduced for the plugin config settings.
Plugin Dashboard environment variables will have new variables added to their respective config files: list file changes outside of Plugin. System files.
Timeline:
Order | Title | Link | Start | Finish |
1 | New Shopify Plugin for Widget Installation. | 18/06/2024 | 18/072024 | |
1.1 | Local Dev Setup & Plugin Dashboard Onboarding. | 18/06/2024 | Ongoing | |
1.2 | Shopify Onboarding. | 18/06/2024 | 28/072024 | |
1.3 | Plugin - Coding - Planning & Unassigned time tracking. | 28/06/2024 | 04/072024 | |
1.4 | Plugin - Coding - Installation | 04/072024 | 14/07/2024 | |
1.5 | Plugin - Coding - Uninstallation | 04/072024 | 14/07/2024 | |
1.6 | Plugin - Coding - Configuration - CRUD | 06/07/2024 | 14/07/2024 | |
1.7 | Plugin - Coding - Refactor & Comment & Document | 14/07/2024 | 18/072024 | |
1.8 | Plugin - Coding - FrontEnd design to Polaris | 16/07/2024 | 20/072024 | |
1.9 | Plugin - Coding - Add form to capture widget code to display on their site. | 16/07/2024 | 20/072024 | |
1.10 | Widget Store Front Display Requirements. | 29/07/2024 | 31/07/2024 | |
1.11 | Widget Store Front Display Functionality. | 29/07/2024 | 31/07/2024 |
Process:
Requirement Gathering.
Planning & Design.
Plugin - Coding - Planning & Unassigned time tracking. PRD-644
Implementation.
Dev setup
Local Dev Setup & Plugin Dashboard Onboarding. PRD-642
Shopify setup
Shopify Onboarding. PRD-643
Plugin development
Plugin - Coding - Planning & Unassigned time tracking. PRD-644
Plugin - Coding - Installation. PRD-773
Plugin - Coding - Uninstallation. PRD-774
Plugin - Coding - Configuration - CRUD. PRD-763
Plugin - Coding - Refactor & Comment & Document. PRD-764
Widget Store Front Display Requirements. PRD-855
Widget Store Front Display Functionality. PRD-856
Process Breakdown:
Requirement Gathering:
Plugin Dashboard Repo - Local Dev Setup & Research.
Develop overview of system.
Define system purpose.
Shopify Dashboard & Research.
Develop overview of Shopify system.
Define Shopify requirements.
Planning & Design:
The plugin is broken down into components, namely:
Each in their respective page.
Main Process Flow Diagrams:
Inc drawio | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|