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

# Shipwide

> A multi-platform starter kit — build your product on one shared foundation for web, iOS, Android and desktop.

Shipwide is a **multi-platform starter kit**: the shared foundation extracted from real
production apps, packaged to be generic and reusable. It's a starting point you build your
product on — not a finished app. **Four parts, one product:**

| Part               | What it is                                                                         | Stack                                             |
| ------------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------- |
| `shipwide_api`     | The backend — accounts, auth, sessions, subscriptions, support, uploads, admin API | Fastify + Drizzle + PostgreSQL + Redis (Node 22+) |
| `shipwide_app`     | The client — one codebase for web, iOS, Android, desktop                           | Vue 3 + Ionic + Capacitor + Tauri                 |
| `shipwide_admin`   | The operator panel — run one deployment                                            | Vue 3 SPA                                         |
| `shipwide_website` | The marketing site                                                                 | Astro (static) + SCSS                             |

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/shipwide/quickstart">
    Run all four parts locally in a few minutes.
  </Card>

  <Card title="Architecture" icon="sitemap" href="/shipwide/architecture">
    How the parts connect and the wire contract they share.
  </Card>

  <Card title="Configuration" icon="gear" href="/shipwide/configuration">
    Every environment variable, per part, and the wiring that must agree.
  </Card>

  <Card title="Customization" icon="paintbrush" href="/shipwide/customization">
    Rebrand and theme the app, admin and site.
  </Card>
</CardGroup>

## What you're starting from

Shipwide is a foundation, not a finished app — here's what that means in practice:

* **The exported pieces are ready to use** — backend handlers, Vue composables, api-client
  functions, components. Some aren't wired into a screen yet; that's intentional, they're
  there for you to build on.
* **The account, sessions and settings screens are placeholders on purpose.** The kit gives
  you the plumbing behind them; you build your product's screens on top.