[MVP] Status & next steps

[bryanchriswhite]

Status

Proof-of-Concept + MVP

Complete

• Postgraphile GQL server API
  • Upserting postgres tables via GQL mutations
  • Querying postgres tables via GQL queries
  • Full-text search support / integration
• Frontend Web UI
  • UI design requirements (only in my mind, presently)
  • GQL client queries postgraphile
  • Redux store integration
  • Basic components and logic
    • (will render comments if present in DB)
• Indexer
  • FSM definition and transitions
  • Querying GitHub via GQL
    • (only need 2 reusable queries)

In Progress

• Indexer
  • FSM service logic (incomplete)
• Frontend Web UI
  • UI incomplete
    • Update after adding commentables relationship
    • Search filter MVP TBD
    • Indexer status indicators TBD
  • Postgraphile queries
    • Update after adding commentable relationship
• Bull queue Kue bee-queue integration
  • replace naive (non-functional) queue implementation
    • (perhaps by asking GPT nicely)

Outstanding

• Postgraphile
  • Add commentables table & relationship to comments
    • via DB migration

Architecture Status

(Doesn't render well in GitHub's dark mode - apologies 🙇 - highlight to work-around)

graph TD
    subgraph Postgres
        ts[full-text search engine]
        rd[relational database]
    end

    subgraph Postgresphile
        gq[postgres GraphQL Server]
    end

    subgraph Indexer
        xs[xstate Finite State Machine]
        gh[GitHub GQL Client]
        kq[bee queue processing]
    end

    subgraph rs[Redis]
        ss[SET]
    end

    subgraph GitHub
        ghgq[GitHub GraphQL API]
    end

    subgraph Frontend Web UI
        rc[React]
        rx[Redux]
    end

    rc --> rx
    rx --> gq

    kq --> ss

    xs --> kq
    xs --> rd
    xs --> gh

    gq --> ts
    gq --> rd

    gh --> ghgq

    style ts fill:#7ed957,stroke:#000000  % Complete
    style rd fill:#7ed957,stroke:#000000  % Complete
    style gh fill:#7ed957,stroke:#000000  % Complete
    style ghgq fill:#7ed957,stroke:#000000  % Complete
    style ss fill:#7ed957,stroke:#000000  % Complete

    style gq fill:#f9a825,stroke:#000000  % In Progress
    style rc fill:#f9a825,stroke:#000000  % In Progress
    style rx fill:#f9a825,stroke:#000000  % In Progress
    style xs fill:#f9a825,stroke:#000000  % In Progress
    style kq fill:#f9a825,stroke:#000000  % In Progress 

    subgraph MVP Status - Legend
        complete[Complete]
        in_progress[In Progress]
        outstanding[Outstanding]

        style complete fill:#7ed957,stroke:#000000  % Complete
        style in_progress fill:#f9a825,stroke:#000000  % In Progress
        style outstanding fill:#fb8a7b,stroke:#000000  % Outstanding
    end

Loading