WC-Telegram-SaaS

Production-oriented, multi-tenant SaaS foundation for managing WooCommerce stores through Telegram.

Architecture

+-------------------+        +-------------------+
| Telegram Managers |------->| grammY Bot        |
+-------------------+        +---------+---------+
                                           |
                                           v
+-------------------+        +-------------+-----+
| WooCommerce Store |------->| Caddy             |
| Connector Plugin  | HTTPS  | Reverse Proxy     |
+-------------------+        +-------------+-----+
                                           |
                                           v
                             +-------------+-----+
                             | NestJS Backend    |
                             | Multi-tenant API  |
                             +------+-------+----+
                                    |       |
                                    v       v
                           +--------+--+  +--+-------------+
                           | PostgreSQL |  | Redis / BullMQ |
                           +-----------+  +----------------+

The monorepo contains:

• backend/ — NestJS API and future BullMQ workers.
• telegram-bot/ — grammY bot process.
• wp-content/plugins/ — lightweight WooCommerce onboarding connector plugin.
• docs/ — architecture and developer documentation.
• scripts/ — local infrastructure initialization scripts.

n8n is optional internal tooling and is not part of the production runtime.

Quick Start

Prerequisites: Docker with Docker Compose v2.

cp .env.example .env
docker compose up --build

Verify the stack:

• Backend health: http://127.0.0.1:3000/api/health
• Container status: docker compose ps

The repository Compose file publishes only the backend on host loopback; PostgreSQL, Redis, and the bot remain private. Production uses host-level Caddy in front of that loopback listener. See the production security section in the setup guide before exposing any service.

Stop the stack with docker compose down. Add --volumes only when you intentionally want to delete local PostgreSQL, Redis, and Caddy data.

Development

Install workspace dependencies and run the quality checks:

npm install
npm run prisma:validate --workspace backend
npm run prisma:generate --workspace backend
npm run typecheck
npm run lint
npm run format:check
npm test

The Prisma schema and versioned migrations live under backend/prisma/.

Use Conventional Commits for repository history, for example feat(init): scaffold monorepo.

See Local Setup for detailed instructions. Project planning and decisions are maintained in the remaining files under docs/.