Page Comparison

...

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.

     • 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

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

   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.
      Shopify PHP - https://github.com/Shopify/shopify-api-php
      https://shopify.dev/docs/apps/launch/app-requirements-checklist
      https://shopify.dev/docs/api/app-bridge
      So based upon our tech stack it seems like we actually just use the PHP library / dependancy to intergrate the app with Shopify.

   2. Shopify app authentication and authorization.
      https://shopify.dev/docs/apps/build/authentication-authorization
      https://shopify.dev/docs/apps/build/authentication-authorization/set-embedded-app-authorization?extension=javascript
      Authentication is the process of verifying the identity of the user or the app. To keep transactions on Shopify’s platform safe and secure, all apps connecting with Shopify APIs must authenticate when making API requests.

      Authorization is the process of giving permissions to apps. When an app user installs a Shopify app they authorize the app, enabling the app to acquire an access token. For example, an app might be authorized to access orders and product data in a store.
      Create a route for starting the OAuth method such as /login. In this route, the Shopify\Auth\OAuth::begin method will be used. The begin method returns a URL that will be used for redirecting the user to the Shopify Authentication screen.To complete the OAuth process, your app needs to validate the callback request made by Shopify after the merchant authorizes your app to access their store data.

      To do that, you can call the Shopify\Auth\OAuth::callback method in the endpoint defined in the redirectPath argument of the begin method.
      

   3. Shopify - Ngrok.
      In the Shopify ecosystem, embedded apps run in an iframe in a production environment. In order to test the functionality of your app within that context in development, you’re going to want to tunnel what you have running locally to an accessible URL.

Plugin Development:

6. DB Schema

   Code Block

   TABLE `netcomm_configuration` : `id` int(11) NOT NULL AUTO_INCREMENT, `user_id` int(11) DEFAULT NULL, `shop_url` varchar(255) COLLATE utf8_unicode_ci NOT NULL, `access_token` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `app_uninstall_web_hook_id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `order_fulfilled_web_hook_id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `widget_token` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `widget_language` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `terms_and_conditions` tinyint(1) NOT NULL DEFAULT '1', `instruction` tinyint(1) NOT NULL, `shop_id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `shop_interface_password` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `netcomm_id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL, `store_data` longtext COLLATE utf8_unicode_ci, `enabled` tinyint(1) NOT NULL DEFAULT 'false', `created` datetime NOT NULL, `updated` datetime NOT NULL, `member_of_netcomm` tinyint(1) NOT NULL DEFAULT 'false', `member_of_ekomi` tinyint(1) NOT NULL DEFAULT 'false', PRIMARY KEY (`id`), UNIQUE KEY `UNIQ_89D23822678D9590` (`shop_url`), UNIQUE KEY `UNIQ_89D238224D16C4DD` (`shop_id`), UNIQUE KEY `UNIQ_89D23822B6A2DD68` (`access_token`), UNIQUE KEY `UNIQ_89D23822A76ED395` (`user_id`), CONSTRAINT `FK_89D23822A76ED395` FOREIGN KEY (`user_id`) REFERENCES `fos_user` (`id`)

7. Install - Process definition:
   

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: