110 lines
2.7 KiB
Markdown
110 lines
2.7 KiB
Markdown
# FamiliarOS Website
|
|
|
|
Public web surface for FamiliarOS: marketing pages, auth/account routes,
|
|
pricing, support, docs entrypoints, and the hosted `/spinners` demo.
|
|
|
|
## Canonical note
|
|
|
|
This `website/` directory is the canonical FamiliarOS website source inside the
|
|
main product repo at `/home/dev/src/FamiliarOS`.
|
|
|
|
The former redundant parallel surfaces were temporarily staged for a VPS M
|
|
handoff under:
|
|
|
|
- `/home/dev/VPSM/familiaros-parallel-surface-backups/2026-06-18T002123Z`
|
|
|
|
That local XXL-side staging folder was later deleted on `2026-06-18` UTC.
|
|
If it is recreated, it must be a browseable directory snapshot rather than a
|
|
tar/zip archive.
|
|
|
|
and then removed from the active workspace:
|
|
|
|
- `/home/dev/src/_archived_FamiliarOSWebsite_2026-06-17`
|
|
- `/home/dev/src/VectorShell/websites/familiaros`
|
|
- `/home/dev/src/openpets-clean`
|
|
|
|
Do not recreate sibling live website roots unless a later packet explicitly
|
|
reopens that architecture.
|
|
|
|
## Main responsibilities
|
|
|
|
- public homepage and marketing flows
|
|
- login and register flows
|
|
- pricing, legal, support, and docs-facing routes
|
|
- spinner demo and design-lab surfaces
|
|
- static frontend deployment to `familiar-os.com`
|
|
- self-hosted auth backend in `server/`
|
|
|
|
## Tech stack
|
|
|
|
- React 18
|
|
- TypeScript
|
|
- Vite
|
|
- Tailwind CSS
|
|
- TanStack Query
|
|
- React Router
|
|
- SuperTokens auth frontend integration
|
|
- Vitest + Playwright
|
|
|
|
## Important directories
|
|
|
|
```text
|
|
website/
|
|
├── src/ # React app
|
|
├── server/ # Auth backend + SuperTokens integration
|
|
├── docs/ops/ # Deployment and VPS/auth runbooks
|
|
├── config/ # UX, a11y, and performance gates
|
|
├── public/ # Static assets
|
|
└── dist/ # Production build output
|
|
```
|
|
|
|
## Local development
|
|
|
|
```bash
|
|
cd /home/dev/src/FamiliarOS/website
|
|
npm ci
|
|
npm run dev
|
|
```
|
|
|
|
Default local frontend URL:
|
|
|
|
- `http://localhost:5173`
|
|
|
|
If you need the auth backend locally, use the `server/` folder and the VPS/auth
|
|
runbooks under `docs/ops/`.
|
|
|
|
## Validation
|
|
|
|
```bash
|
|
npm run type-check
|
|
npm run test
|
|
npm run build
|
|
```
|
|
|
|
Additional gates exist for:
|
|
|
|
- accessibility
|
|
- e2e critical workflows
|
|
- UX journeys
|
|
- performance budgets
|
|
- bundle budgets
|
|
|
|
## Deployment
|
|
|
|
Primary deployment/runbook docs:
|
|
|
|
- `docs/ops/DEPLOYMENT_RUNBOOK.md`
|
|
- `docs/ops/FAMILIAROS_SERVER_INSTANCE_GUIDANCE.md`
|
|
- `docs/ops/GITHUB_AUTH_STATUS.md`
|
|
|
|
Production target:
|
|
|
|
- domain: `https://familiar-os.com`
|
|
- static web root: `/var/www/familiaros`
|
|
- auth API: `https://api.familiar-os.com`
|
|
|
|
## Current product note
|
|
|
|
This site is post-rebrand but still undergoing consolidation and cleanup.
|
|
If you find FamiliarOS-external or inherited copy, treat it as stale and route
|
|
cleanup through the current product roadmap and website hardening packets.
|