> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theroyalglow.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> The complete documentation for the Royal Glow Salon & Spa platform — for engineers, operators, and anyone in the organisation.

# Royal Glow Salon & Spa — Documentation

Welcome. This is the complete reference for the Royal Glow Salon & Spa platform —
the software that runs the salon's website, bookings, billing, customer
relationships, memberships, loyalty, marketing, and day-to-day operations.

It is written for **everyone**: a new engineer joining the project, an operator
running the salon, or anyone in the organisation who simply wants to understand
how things work. Each page opens with a plain-language summary before going into
technical detail, so you can read as deep as you need.

<Info>
  **New here?** Pick a path below, or jump straight to
  [Business Overview](/docs/product/business-overview) for the non-technical
  picture or [Getting Started](/docs/getting-started) to run the project locally.
</Info>

## Choose your path

<Steps>
  <Step title="Understand the business">
    Read [Business Overview](/docs/product/business-overview) and the
    [Customer Guide](/docs/product/customer-guide) for what the platform does and
    who uses it — no technical background needed.
  </Step>

  <Step title="Run it locally">
    Follow [Getting Started](/docs/getting-started) to install the monorepo and boot
    all three apps. Everything builds with **zero** secrets configured.
  </Step>

  <Step title="Go deeper">
    Explore [Architecture](/docs/architecture), the [Data Model](/docs/data-model),
    and the [API Reference](/docs/api-reference) to understand how it is built.
  </Step>

  <Step title="Ship & operate">
    Use [Operations](/docs/operations), [Deployment](/docs/deployment), and the
    [Project Status](/docs/project-status) page when it is time to release.
  </Step>
</Steps>

## What is Royal Glow?

Royal Glow Salon & Spa is a premium beauty and wellness business in Bengaluru,
India. This platform is its full digital operations system — a single,
integrated product covering the customer-facing website and booking experience,
the staff/admin portal, and all the automation behind the scenes.

## Find your way around

<Columns cols={2}>
  <Card title="Project Status" href="/docs/project-status">
    Live build & production-readiness snapshot — what's done and what's left.
  </Card>

  <Card title="Product" href="/docs/product">
    What the platform does, who uses it, and how — in plain language.
  </Card>

  <Card title="Features" href="/docs/features">
    Every feature explained: booking, memberships, gems, offers, CRM, billing, and more.
  </Card>

  <Card title="Getting Started" href="/docs/getting-started">
    Set up and run the project on your machine.
  </Card>

  <Card title="Tech Stack" href="/docs/tech-stack">
    Every technology used and why it was chosen.
  </Card>

  <Card title="Architecture" href="/docs/architecture">
    How the system is structured and hosted.
  </Card>

  <Card title="System Design" href="/docs/system-design">
    High-level and low-level design — diagrams, flows, and decisions.
  </Card>

  <Card title="API Reference" href="/docs/api-reference">
    Every API endpoint, with requests, responses, and error codes.
  </Card>

  <Card title="Data Model" href="/docs/data-model">
    The 38-table database — tables, enums, and conventions.
  </Card>

  <Card title="Security & Compliance" href="/docs/security">
    How customer data is protected and India's DPDP Act is honoured.
  </Card>

  <Card title="Operations" href="/docs/operations">
    Running, monitoring, deploying, and recovering the platform.
  </Card>

  <Card title="Glossary" href="/docs/glossary">
    Plain-language definitions of every term used here.
  </Card>

  <Card title="FAQ" href="/docs/faq">
    Quick answers to common questions.
  </Card>
</Columns>

## How this documentation is organised

| Section                | For whom         | What it covers                                                              |
| ---------------------- | ---------------- | --------------------------------------------------------------------------- |
| **Product**            | Everyone         | The business, the people who use it, and how they use it                    |
| **Engineering**        | Developers       | Setup, stack, architecture, design, APIs, data, pages, frontend             |
| **Platform**           | Developers / ops | Background jobs, realtime, notifications, email, SEO, analytics, monitoring |
| **Quality & Security** | Developers / ops | Security, compliance, error handling, testing, configuration                |
| **Operations**         | Ops / on-call    | Deployment, branching, seeding, launch, runbook                             |
| **Reference**          | Everyone         | Glossary and FAQ                                                            |

## At a glance

* **Three apps** — the customer site + admin portal (`apps/web`), the marketing CMS (`apps/cms`), and this documentation site (`docs`).
* **Edge-first** — served globally from Cloudflare's edge with a Node.js origin for heavier work.
* **India-first** — INR pricing in paise, GST 18% inclusive, IST timezone, DPDP Act compliance, DD/MM/YYYY dates.
* **₹0/month at launch** — every external service runs on a free tier.


## Related topics

- [Business Overview](/content/docs/product/business-overview.md)
- [SEO & AI Visibility](/content/docs/seo.md)
- [High-Level Design](/content/docs/system-design/high-level-design.md)
- [Analytics](/content/docs/analytics.md)
- [Project Status](/content/docs/project-status.md)
