Home

Welcome to the FoxCommerce Engineering Wiki. Here you can find information about the overall engineering team, as well as the individual projects. Look below to find your way around.

Design Documents

• System Architecture
  • The FoxCommerce System Architecture
  • Simplified Architecture Graph
• Activity Trail
• Discount Model
• Intelligent Commerce
  • Intelligent Commerce
  • River Rocky Proxy: The Green River Polishes Stones
• Inventory
• Product Model
  • Everything is Search
  • The Enlightened, Post-Modern Product Model
  • Product Model Versioning
• Production
  • The Happy Production Model
• Security
  • The Judgement of Solomon

Architecture

Customer's Simplified View of FoxCommerce Platform

It's good to keep in mind that our customers will understand a simplified version of what's actually happening at FoxComm. They will mostly be interacting with the Store Admin to manage their catalog and merchandising, and their design & dev teams will be building their public storefront, most likely based on the Firebird starter theme.

                                            ╮
                    ┌───────────────────┐   │
┌─────────────┐     │ Public Storefront │   ├ Frontend
│ Store Admin │     └─────────┬─────────┘   │
└──────┬──────┘               │             ╯
       └──────────┬───────────┘
                  │                         ╮
         ┌────────┴────────────┐            │
         │ FoxComm Backend API │            ├ Backend
         └─────────────────────┘            │
                                            ╯

FoxCommerce Platform Architecture

More detail on what's going on behind the scenes.

                                                               ╮
                            ┌──────────────────────────────┐   │
┌─────────────────────┐     │ Public Storefront [Firebird] │   ├ Frontend
│ Store Admin [Ashes] │     └──────────────┬───────────────┘   │
└─────────┬───────────┘                    │                   ╯
          └───────────────┬────────────────┘
                          │
               ┌──────────┴──────────┐                         ╮
               │ API Gateway [nginx] │                         │
               └──────────┬──────────┘                         │
                          │                                    │
             ┌────────────┴────────────┐                       │
      ┌──────┴──────┐         ┌────────┴──────────┐            │
      │ Phoenix API │         │ ElasticSearch API │            ├ Backend
      └──────┬──────┘         └──────────┬────────┘            │
          ╭──┴─╮                         ↑ update indices      │
          │    │     ┌───────┐     ┌─────┴───────┐             │
          │ DB ├────→│ Kafka │────→│ Green River │             │
          │    │     └───────┘     └─────────────┘             │
          ╰────╯                                               ╯

Core FoxCommerce Platform Components

Frontend UI

See also customer implementation & theming and developing frontend applications

• Ashes Store Admin UI — React.js based UI for Phoenix
• API.js library — Simple API client for interacting with Phoenix API; framework-agnostic javascript

Libraries & Utilities

• Tabernacle — Core provisioning tools.
• Wings — Shared UI components & tools