Netcomm Plugin

Owned by Emile De Wilde (Unlicensed)
Last updated: Aug 05, 2024
6 min read
Task: https://ekomi01.atlassian.net/browse/PRD-618

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

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.

PRD-618

18/06/2024

18/072024

1.1

Local Dev Setup & Plugin Dashboard Onboarding.

PRD-642

18/06/2024

Ongoing

1.2

Shopify Onboarding.

PRD-643

18/06/2024

28/072024

1.3

Plugin - Coding - Planning & Unassigned time tracking.

PRD-644

28/06/2024

04/072024

1.4

Plugin - Coding - Installation

PRD-773

04/072024

14/07/2024

1.5

Plugin - Coding - Uninstallation

PRD-774

04/072024

14/07/2024

1.6

Plugin - Coding - Configuration - CRUD

PRD-763

06/07/2024

14/07/2024

1.7

Plugin - Coding - Refactor & Comment & Document

PRD-764

14/07/2024

18/072024

1.8

Plugin - Coding - FrontEnd design to Polaris

PRD-795

16/07/2024

20/072024

1.9

Plugin - Coding - Add form to capture widget code to display on their site.

PRD-796

16/07/2024

20/072024

1.10

Widget Store Front Display Requirements.

PRD-855

29/07/2024

31/07/2024

1.11

Widget Store Front Display Functionality.

PRD-856

29/07/2024

31/07/2024

Process:

  1. Requirement Gathering. 

    • Local Dev Setup & Plugin Dashboard Onboarding. PRD-642

    • Shopify Onboarding. PRD-643

  2. Planning & Design. 

    • Plugin - Coding - Planning & Unassigned time tracking. PRD-644

  3. Implementation.

    • Dev setup

      • Local Dev Setup & Plugin Dashboard Onboarding. PRD-642

    • Shopify setup

    • 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:

  1. 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.

  2. Planning & Design:
    The plugin is broken down into components, namely:
    Each in their respective page.

    1. Plugin Dashboard Repo - Local Dev Setup & Research

    2. Shopify Dashboard & Research

    3. DB Schema

    4. Plugin Install - Process

    5. Plugin Uninstall Process

    6. Plugin Configuration - eKomi & Netcomm

    7. Widget Token Configuration

    8. Widget Store Front Display Requirements

    9. Widget Store Front Display Functionality


Main Process Flow Diagrams: