Page Comparison

...

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:

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-642644

3. 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-642644

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

     • Define system purpose.

   • Shopify Dashboard & Research.

     • Develop overview of Shopify system.

     • Read Documentation

       • Various App types.

       • Shopify documentation is preferring Shopify CLI App development for Embedded app. 

     Document

     Define Shopify requirements.
     

2. Planning & Design:
   The plugin is broken down into components, namely:
   

   1. App install

      • Install requires registration as an app provider.

      • Authentication process and Token exchange.

      • The app registers within Shopify and Customer shop.

      • Privilege establishment

      • Persists to DB.

   2. App uninstall

      • Authentication process and Token exchange.

      • The app un-registers within Shopify and Customer shop.

      • Deletes from DB.

   3. App Configuration

      • down into cdown into cConfiguration settings. App requires configuring.
        Options are provided to be either an eKomi client or Netcomm or both.

        • eKomi Client settings:

          • ShopId

          • Shop Interface Password

        • Netcomm Client settings:

          • NetcommId

      • App configuration will be persisted in the DB.
        CRUD functionality.

   4. Requirements:
      Shopify has requirements that each app should meet.
      Link to requirements.

      1. App is installable from shopify store and needs to be registered.

      2. App needs to store Netcomm & eKomi credentials.

      3. App is embedded, uses Shopify App Bridge functionality.
         Link to App Bridge

   5. Native Symfony / Docker app.

   6. DB Entity

   Implementation:

3. Local Dev Setup.

   1. Setup environment to develop - environment specifics needed for the repo to work.
      

4. Learn Plugin Dashboard system.

   1. Read Plugin documentation.

   2. Read Plugin code as I’m supposed to model off them.
      

5. Shopify Setup

   1. Learn what Shopify requires and how to do development with them.
      

Plugin Development:

6. DB Schema
   Link to schema.

7. Install
   Link to Install process flow.

8. Uninstall
   Link to Uninstall process flow.

9. Configuration CRUD
   Link to Configuration process flow.

10. Refactor / Testing Phase.

11. Identify issues and refactor

Documentation / Commenting.
Document Shopify requirements for apps.
Explain where app meets requirements.
Comment functions and classes.

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: