Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Requirement Gathering:

    • Plugin Dashboard Repo - Local Dev Setup & Research. 

      • Develop overview of system, define system purpose.

    • Shopify Dashboard & Research.

  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

  3. Implementation:

    1. Local Dev Setup.

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

    2. Learn Plugin Dashboard system.

      1. Read Plugin documentation.

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

    3. Shopify Setup

      1. Learn what Shopify requires and how to do development with them.
        https://shopify.dev/docs/apps/launch/app-requirements-checklist

    4. Plugin Development:

      1. DB Schema
        Link to schema.

      2. Install
        Link to Install process flow.

      3. Uninstall
        Link to Uninstall process flow.

      4. Configuration CRUD
        Link to Configuration process flow.

      5. Refactor / Testing Phase.

      6. Identify issues and refactor

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

...