Skip to main content

Introduction

RecoApp is a Shopify app delivering recommendation services to merchants and customers.

Overview​

RecoApp helps Shopify merchants provide personalised product recommendations to their customers by tracking customer behavior and analysing shopping patterns.

System Components​

RecoApp consists of the following main components:

1. recoapp-db: Xata Postgres database​

A PostgreSQL database hosted on Xata, managed through Xata's platform and provides both a REST client and Kysely query builder for type-safe database operations.

2. recoapp-api: NestJS API backed​

A NestJS-powered API that processes customer behavior events and stores them for analysis. It handles all the heavy lifting of tracking and data processing.

3. recoapp-shopify: Shopify App Remix frontend​

The merchant-facing admin interface built with Remix that integrates directly into the Shopify admin panel. This is where store owners configure their recommendation settings.

4. recoapp-docs: Docusaurus documentation​

This documentation site built with Docusaurus provides comprehensive guides, API references, and architectural documentation for the RecoApp platform, serving as the central knowledge base for developers and staff.

How It Works​

  1. Customers browse a merchant's Shopify store
  2. The web pixel tracks their behavior (product views, cart additions, etc.)
  3. Events are sent to the RecoApp API for processing
  4. Data is stored and analysed to generate insights
  5. Merchants can view recommendations and insights in the Shopify admin app

Getting Started​

Documentation for each component is coming soon. In the meantime, refer to the CLAUDE.md files in each project directory for technical details.