Skip to content

ShopVirge Backend

Welcome to the ShopVirge Backend documentation.

ShopVirge is a FastAPI REST API for managing shop pricelists, products, categories, orders, and attributes. It uses a multi-tenant architecture where most resources hang off a shop: /shops/{shop_id}/....

FastAPI-style live API reference

The running server exposes an interactive OpenAPI UI at:

  • Swagger UI: /docs
  • ReDoc: /redoc
  • Raw spec: /openapi.json

These are generated from the live FastAPI app, so they always match the running code. This site covers the architecture, rationale, and operational details that the OpenAPI spec can't.

Where to go next

  • Quickstart

    Get a local dev server running. Mirrors the content of README.md.

  • Architecture

    Request flow, database layer, two-branch migrations, and C4 diagrams.

  • API

    Router layout, multi-tenant shop scoping, authentication, email notifications.

  • Development

    Local setup, testing, code style, and writing migrations.

  • Contributing

    Branching, PR workflow, CI gates, and how the docs site is published.

About this site

This site is built with Material for MkDocs — the same stack that powers the FastAPI documentation. Diagrams are authored with Mermaid directly inside Markdown, and the existing drawio C4 diagrams are exported to SVG for the C4 diagrams page.