mirror of
https://github.com/Sea-Haven-Industries/shoc-frontend-new.git
synced 2026-09-30 03:23:12 +00:00
chore: correct Sea Haven branding and rewrite README (#25)
* fix: correct Sea Haven branding in page title and wordmark * chore: use correct company name in docs and comments * docs: rewrite README * docs: add README badge block per github-standards * fix: update command syntax in deployment instructions * fix: replace template PWA icons and manifest branding * test: assert PWA manifest branding
This commit is contained in:
parent
c68d47af7b
commit
042b9db2ac
20 changed files with 230 additions and 96 deletions
230
README.md
230
README.md
|
|
@ -1,80 +1,180 @@
|
|||
# SeaHaven Admin
|
||||
# SHOC Frontend (`shoc-frontend-new`)
|
||||
|
||||
Vite + React SPA for SeaHaven facility management (work orders, vendor portal, uplifts, and related admin features).
|
||||
[](https://github.com/Sea-Haven-Industries/shoc-frontend-new/actions/workflows/ci.yaml)
|
||||
[](https://github.com/Sea-Haven-Industries/shoc-frontend-new/actions/workflows/deploy.yml)
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
## Requirements
|
||||
Vite + React SPA for Sea Haven facility management (SHOC): work orders, vendor
|
||||
portal, uplifts, and related admin features. This is the selective rebuild of
|
||||
the legacy SHOC frontend — new code follows the IrisLoan.Admin conventions
|
||||
documented in [`docs/ARCHITECTURE_PLAN.md`](docs/ARCHITECTURE_PLAN.md).
|
||||
|
||||
- Node.js 22.22.1+
|
||||
- npm 11.16.0
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ----------------- | ----------------------------------------------- | ----------------------- |
|
||||
| `VITE_API_URL` | Ky API prefix (baked into the production build) | `/api` |
|
||||
| `VITE_API_TARGET` | Dev proxy target for `/api` (Vite only) | `http://localhost:5141` |
|
||||
|
||||
`VITE_API_URL` is the full API base prefix. Route paths in `API_PATHS` do **not** include `/api` — only this variable supplies it.
|
||||
|
||||
- **Development:** use `VITE_API_URL=/api`. The Vite dev server proxies `/api` to `VITE_API_TARGET`.
|
||||
- **Production:** use an absolute URL that **ends with `/api`** (e.g. `https://api.example.com/api`). Absolute URLs without `/api` will produce broken API requests.
|
||||
|
||||
See [`.env.example`](.env.example) and [`.env.production`](.env.production) for reference values.
|
||||
|
||||
## Scripts
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------- | ------------------------------------------ |
|
||||
| `npm run dev` | Start Vite dev server on port 3000 |
|
||||
| `npm run build` | Type-check and production build to `dist/` |
|
||||
| `npm run preview` | Preview production build locally |
|
||||
| `npm test` | Run Vitest unit tests |
|
||||
| `npm run test:watch` | Run Vitest in watch mode |
|
||||
| `npm run lint` | ESLint |
|
||||
| `npm run lint:fix` | ESLint with auto-fix |
|
||||
| `npm run format` | Prettier write |
|
||||
| `npm run format:check` | Prettier check (used in CI) |
|
||||
- **GitHub:** `Sea-Haven-Industries/shoc-frontend-new`
|
||||
- **Hosted at:** <https://dev.seahaven.com> (dev environment; the only environment today)
|
||||
- **Backend API:** `https://api.dev.seahaven.com/api` (called directly, cross-origin) — source: `Sea-Haven-Industries/shoc-backend`
|
||||
|
||||
## Architecture
|
||||
|
||||
New code lives under `src/domain/`, `src/app/`, and `src/api/` following the IrisLoan conventions documented in `docs/ARCHITECTURE_PLAN.md`.
|
||||
Static SPA hosting on AWS, provisioned by a CDK app local to this repo
|
||||
([`infra/cdk/`](infra/cdk/README.md)). CloudFront serves the built `dist/`
|
||||
from a private S3 bucket; the SPA calls the backend directly over HTTPS at
|
||||
`VITE_API_URL` (no `/api` proxy at the CDN — the backend allows CORS).
|
||||
|
||||
## CI
|
||||
```mermaid
|
||||
graph LR
|
||||
U[Browser] -->|HTTPS dev.seahaven.com| CF[CloudFront]
|
||||
CF -->|OAC| S3[S3 seahaven-shoc-frontend-dev]
|
||||
CF -.->|viewer-request fn| FN[SPA rewrite → /index.html]
|
||||
U -->|HTTPS api.dev.seahaven.com/api CORS| API[SHOC backend API]
|
||||
GH[GitHub Actions push to dev] -->|OIDC| ROLE[githubdeploy-shoc-frontend-new-dev]
|
||||
ROLE -->|cdk deploy + s3 sync + invalidation| S3
|
||||
```
|
||||
|
||||
GitHub Actions workflow (`.github/workflows/ci.yml`) runs on push and pull requests:
|
||||
Frontend stack: React 19, TypeScript, Vite, Tailwind CSS 4 + MUI, TanStack
|
||||
Query, React Router (via `@generouted/react-router`), React Hook Form + Zod,
|
||||
Ky HTTP client. Source layout: `src/api/`, `src/domain/`, `src/app/` (see the
|
||||
architecture plan for the keep/discard migration matrix).
|
||||
|
||||
1. `npm run format:check`
|
||||
2. `npm run lint`
|
||||
3. `npm run build`
|
||||
4. `npm test`
|
||||
## AWS Resources
|
||||
|
||||
Local pre-commit hooks (Husky + lint-staged) run ESLint and Prettier on staged files.
|
||||
Stack **`shoc-frontend-dev`** — CDK, account `396287094661`, region
|
||||
`us-east-1`. Defined in [`infra/cdk/lib/frontend-stack.ts`](infra/cdk/lib/frontend-stack.ts).
|
||||
|
||||
## Deployment (CI/CD)
|
||||
| Resource | Name | Purpose |
|
||||
| ----------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| S3 bucket | `seahaven-shoc-frontend-dev` | Private origin (BLOCK_ALL, SSE, versioned; OAC-only reads) |
|
||||
| CloudFront distribution | (stack output `DistributionId`) | HTTPS static hosting on `dev.seahaven.com`, ACM `*.seahaven.com` |
|
||||
| CloudFront Function | `SpaRewrite` | Viewer-request rewrite of extensionless paths to `/index.html` (deep links) |
|
||||
| IAM role | `githubdeploy-shoc-frontend-new-dev` | GitHub Actions OIDC deploy role, trust scoped to `repo:Sea-Haven-Industries/shoc-frontend-new:ref:refs/heads/dev` |
|
||||
| Route 53 records | A/AAAA apex alias in zone `dev.seahaven.com` (`Z07671212N75U4YLPWZR8`) | Points the custom domain at CloudFront |
|
||||
|
||||
The app is hosted on **AWS S3 + CloudFront**, provisioned by an **AWS CDK** app
|
||||
local to this repo ([`infra/cdk/`](infra/cdk/README.md)). Deployment runs
|
||||
through the org's reusable GitHub Actions workflow via **OIDC** (no stored AWS
|
||||
keys):
|
||||
No Lambdas, queues, or databases — this stack is static hosting only.
|
||||
|
||||
- Push to `dev` → `.github/workflows/deploy.yml` calls the org reusable
|
||||
`cd-cdk.yaml`, which runs `cdk deploy` (infra) then `scripts/deploy-web.sh`
|
||||
(builds the SPA, syncs `dist/` to S3, invalidates CloudFront).
|
||||
- Served on the custom domain `dev.seahaven.com`; the SPA calls the backend
|
||||
directly over HTTPS at `VITE_API_URL` (`https://api.dev.seahaven.com/api`,
|
||||
cross-origin — the backend allows CORS). `VITE_API_URL` is baked into the
|
||||
build, so it is per-environment.
|
||||
- First-time provisioning (OIDC provider, CDK bootstrap, first local deploy, the
|
||||
`AWS_DEPLOY_ROLE_ARN` secret) is a one-time admin task — see
|
||||
[`infra/cdk/README.md`](infra/cdk/README.md).
|
||||
## Configuration
|
||||
|
||||
## Development proxy
|
||||
### Secrets
|
||||
|
||||
During `npm run dev`, requests to `/api` are proxied to `VITE_API_TARGET` (see `vite.config.ts`).
|
||||
No Secrets Manager or SSM parameters. The one secret is a **GitHub Actions
|
||||
repo secret**:
|
||||
|
||||
| Secret | Purpose |
|
||||
| --------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `AWS_DEPLOY_ROLE_ARN` | ARN of `githubdeploy-shoc-frontend-new-dev`, passed to the org reusable CD workflow |
|
||||
|
||||
### Environment variables (build-time, `VITE_*`)
|
||||
|
||||
| Variable | Description | Dev value |
|
||||
| ----------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------- |
|
||||
| `VITE_API_URL` | Ky API base prefix, **baked into the build** at `vite build` | `/api` (dev server) / `https://api.dev.seahaven.com/api` (production build) |
|
||||
| `VITE_API_TARGET` | Dev-proxy target for `/api` (Vite dev server only) | `http://localhost:5141` |
|
||||
|
||||
`VITE_API_URL` supplies the full API prefix — route paths in `API_PATHS` do
|
||||
**not** include `/api`. Absolute values **must end with `/api`**;
|
||||
`vite.config.ts` enforces this via `config/api-url-contract.ts` and fails the
|
||||
build otherwise. See [`.env.example`](.env.example),
|
||||
[`.env.development`](.env.development), and [`.env.production`](.env.production).
|
||||
|
||||
CDK context (domain, certificate ARN, hosted zone) lives in
|
||||
[`infra/cdk/cdk.json`](infra/cdk/cdk.json) so CI runs `cdk deploy` with no flags.
|
||||
|
||||
## Local Development
|
||||
|
||||
Requirements: Node.js ≥ 22.22.1 (CI/CD run Node 24), npm 11.16.0 (pinned via
|
||||
`packageManager`).
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
cp .env.example .env # then set VITE_API_URL=/api for local dev
|
||||
npm run dev # Vite dev server on port 3000, proxies /api → VITE_API_TARGET
|
||||
```
|
||||
|
||||
The dev proxy expects the `shoc-backend` API at `http://localhost:5141`;
|
||||
override with `VITE_API_TARGET` (e.g. `https://api.dev.seahaven.com` to use
|
||||
the deployed dev API).
|
||||
|
||||
| Command | Description |
|
||||
| ------------------------------------------ | ----------------------------------------------------- |
|
||||
| `npm run dev` | Start Vite dev server on port 3000 |
|
||||
| `npm run build` | Type-check (`tsc -b`) and production build to `dist/` |
|
||||
| `npm run preview` | Preview the production build locally |
|
||||
| `npm test` / `npm run test:watch` | Vitest unit tests (once / watch) |
|
||||
| `npm run test:e2e` / `npm run test:e2e:ui` | Playwright e2e tests (headless / UI mode) |
|
||||
| `npm run lint` / `npm run lint:fix` | ESLint (check / auto-fix) |
|
||||
| `npm run format` / `npm run format:check` | Prettier (write / check) |
|
||||
|
||||
Husky + lint-staged run ESLint and Prettier on staged files at commit;
|
||||
commitlint enforces conventional commit messages. Run `npx tsc --noEmit` (or
|
||||
`npm run build`) before pushing to catch type errors early.
|
||||
|
||||
## Contributing
|
||||
|
||||
- Branch from `dev` with a kebab-case description and a prefix matching the
|
||||
work: `feature/`, `bug/`, `hotfix/`, `chore/`, `docs/`, or `refactor/`
|
||||
(e.g. `feature/vendor-portal-filters`, `chore/sea-haven-branding`).
|
||||
- Commit messages follow
|
||||
[Conventional Commits](https://www.conventionalcommits.org) — commitlint
|
||||
rejects anything else at commit time.
|
||||
- Open PRs against `dev`. Both `dev` and `main` are protected: every PR needs
|
||||
a green CI run and an approving review from a code owner
|
||||
(`@Sea-Haven-Industries/internal-dev`); new pushes dismiss stale approvals.
|
||||
Merged branches are deleted automatically.
|
||||
- Promotion flow: `feature/* → dev` (auto-deployed and verified on
|
||||
`dev.seahaven.com`) `→ main` (production promotion — no prod environment
|
||||
exists yet).
|
||||
|
||||
## Deployment
|
||||
|
||||
CI/CD uses the org's reusable workflows (no stored AWS keys — OIDC only):
|
||||
|
||||
- **CI** ([`.github/workflows/ci.yaml`](.github/workflows/ci.yaml)) — on push
|
||||
and PRs to `main`/`dev`, calls
|
||||
`Sea-Haven-Industries/.github` → `ci-typescript-frontend.yaml` (Node 24):
|
||||
format check, lint, build, tests.
|
||||
- **CD** ([`.github/workflows/deploy.yml`](.github/workflows/deploy.yml)) — on
|
||||
push to `dev`, calls `Sea-Haven-Industries/.github` → `cd-cdk.yaml`, which
|
||||
runs `cdk deploy` on `infra/cdk` (stack `shoc-frontend-dev`, `us-east-1`)
|
||||
and then [`scripts/deploy-web.sh`](scripts/deploy-web.sh): `npm run build`,
|
||||
`aws s3 sync dist/` (hashed assets immutable, `index.html` never cached),
|
||||
CloudFront invalidation. Both run as the OIDC deploy role.
|
||||
|
||||
One-time provisioning (OIDC provider, CDK bootstrap, first local deploy,
|
||||
setting `AWS_DEPLOY_ROLE_ARN`) is documented in
|
||||
[`infra/cdk/README.md`](infra/cdk/README.md).
|
||||
|
||||
Manual deploy (emergency/reference only — needs credentials for the
|
||||
external-dev AWS account; the normal path is push to `dev`):
|
||||
|
||||
```bash
|
||||
(cd infra/cdk && npx cdk deploy)
|
||||
STACK_NAME=shoc-frontend-dev AWS_REGION=us-east-1 bash scripts/deploy-web.sh
|
||||
```
|
||||
|
||||
## Operations
|
||||
|
||||
- **Verify:** open <https://dev.seahaven.com> after a green **Deploy** run in
|
||||
the Actions tab; confirm a deep link (e.g. a work-orders route) loads
|
||||
directly and API calls succeed.
|
||||
- **Logs:** deploy logs live in GitHub Actions (CI + Deploy workflows). There
|
||||
are no CloudWatch application logs — the stack is static hosting; runtime
|
||||
errors surface in the browser and on the backend API's side.
|
||||
- **Common failure modes:**
|
||||
- _Stale content after deploy_ — the CloudFront invalidation step failed or
|
||||
is still propagating; re-run the Deploy workflow or invalidate `/*` manually.
|
||||
- _OIDC `AssumeRole` errors_ — the trust policy is scoped to pushes to `dev`
|
||||
on this repo; deploys from other branches/repos are rejected by design.
|
||||
- _Broken API requests after a build_ — `VITE_API_URL` missing the `/api`
|
||||
suffix or carrying the wrong environment's host (it is baked in at build time).
|
||||
- _CORS errors_ — the backend must allow the frontend origin; CloudFront does
|
||||
not proxy `/api`.
|
||||
- **CI and CD both fire on push to `dev` in parallel** — a red-CI commit still
|
||||
deploys (matches the org's push-time-CD model; gating deploy on CI is known
|
||||
follow-up work).
|
||||
|
||||
## Documentation
|
||||
|
||||
- Infra one-time setup and stack details: [`infra/cdk/README.md`](infra/cdk/README.md)
|
||||
- Rebuild strategy and conventions: [`docs/ARCHITECTURE_PLAN.md`](docs/ARCHITECTURE_PLAN.md);
|
||||
design system and UI docs under [`docs/`](docs/)
|
||||
|
|
|
|||
33
config/pwa-manifest.test.ts
Normal file
33
config/pwa-manifest.test.ts
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
import { readFileSync, existsSync } from "node:fs";
|
||||
import path from "node:path";
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
const root = path.resolve(__dirname, "..");
|
||||
const manifest = JSON.parse(readFileSync(path.join(root, "public/manifest.json"), "utf-8")) as {
|
||||
name: string;
|
||||
short_name: string;
|
||||
theme_color: string;
|
||||
icons: Array<{ src: string }>;
|
||||
};
|
||||
const indexHtml = readFileSync(path.join(root, "index.html"), "utf-8");
|
||||
|
||||
describe("PWA install metadata", () => {
|
||||
it("identifies the app as Sea Haven, not template branding", () => {
|
||||
expect(manifest.name).toContain("Sea Haven");
|
||||
expect(manifest.short_name).not.toBe("React App");
|
||||
expect(manifest.name).not.toContain("Create React App");
|
||||
});
|
||||
|
||||
it("uses the design-system theme color, matching index.html", () => {
|
||||
expect(manifest.theme_color).toBe("#1c75bc");
|
||||
expect(indexHtml).toContain(`<meta name="theme-color" content="${manifest.theme_color}" />`);
|
||||
});
|
||||
|
||||
it("only references icon files that exist in public/", () => {
|
||||
for (const icon of manifest.icons) {
|
||||
expect(existsSync(path.join(root, "public", icon.src)), `missing public/${icon.src}`).toBe(
|
||||
true,
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Architecture Plan — SeaHaven (Selective Rebuild)
|
||||
# Architecture Plan — Sea Haven (Selective Rebuild)
|
||||
|
||||
> Aligned with IrisLoan.Admin · Vite SPA + React Router · **no Next.js** · Tailwind + MUI
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# SeaHaven Design System
|
||||
# Sea Haven Design System
|
||||
|
||||
Visual foundation for **seaheven.front**, aligned with [seahaven.desing](https://github.com) tokens and IrisLoan.Admin integration patterns (centralized CSS, `@theme inline`, `cn()`).
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ MUI typography variants in `src/lib/theme/mui-theme.ts` mirror this hierarchy.
|
|||
|
||||
### Prefer themed MUI in forms and data tables
|
||||
|
||||
MUI components inherit Seahaven styling via `mui-theme.ts` overrides (`Button`, `TextField`, `Table`, `Chip`, `Paper`, `Dialog`, `Alert`).
|
||||
MUI components inherit Sea Haven styling via `mui-theme.ts` overrides (`Button`, `TextField`, `Table`, `Chip`, `Paper`, `Dialog`, `Alert`).
|
||||
|
||||
### Prefer semantic Tailwind in layout shells
|
||||
|
||||
|
|
@ -119,9 +119,9 @@ import { cn } from "@/lib/utils";
|
|||
| `StatusBadge` / `WorkOrderStatusBadge` | `components/domain/status-badge.tsx` |
|
||||
| `DocBadge` | `components/domain/doc-badge.tsx` |
|
||||
|
||||
## Legacy → Seahaven mapping
|
||||
## Legacy → Sea Haven mapping
|
||||
|
||||
| Legacy | Seahaven | Consumption |
|
||||
| Legacy | Sea Haven | Consumption |
|
||||
| ------------------------- | ------------------------------ | -------------------------------- |
|
||||
| `#0c4f6f` / `--blue-main` | `--primary` (`#1c75bc`) | MUI `primary.main`, `bg-primary` |
|
||||
| `#083a52` / `--blue-dark` | `--primary-hover` | Button hover |
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Design System Migration Log
|
||||
|
||||
Migration from legacy CSS (`index.css`, `#0c4f6f` palette) to Seahaven DS tokens. Strategy: **MUI-only**.
|
||||
Migration from legacy CSS (`index.css`, `#0c4f6f` palette) to Sea Haven DS tokens. Strategy: **MUI-only**.
|
||||
|
||||
## Phase 1 — Foundation
|
||||
|
||||
| File | Action | Reason |
|
||||
| --------------------------- | ---------- | --------------------------------------------------------------------- |
|
||||
| `src/styles/theme.css` | Created | SoT: 131+ Seahaven tokens + layout/typography/elevation extensions |
|
||||
| `src/styles/theme.css` | Created | SoT: 131+ Sea Haven tokens + layout/typography/elevation extensions |
|
||||
| `src/styles/fonts.css` | Created | Montserrat, DM Sans, JetBrains Mono via `@fontsource` |
|
||||
| `src/styles/typography.css` | Created | Base html/body/heading/caption/label styles |
|
||||
| `src/styles/motion.css` | Created | Duration and easing tokens |
|
||||
|
|
@ -29,7 +29,7 @@ Migration from legacy CSS (`index.css`, `#0c4f6f` palette) to Seahaven DS tokens
|
|||
| `src/components/layout/app-topbar.tsx` | Created | MUI AppBar + header gradient; replaces `Topbar.js` |
|
||||
| `src/app/(protected)/_layout.tsx` | Modified | Uses new layout components |
|
||||
| `src/main.tsx` | Modified | Removed `index.css` import |
|
||||
| `src/app/v/_components/vendor-portal.css` | Modified | Re-tokenized with Seahaven CSS vars |
|
||||
| `src/app/v/_components/vendor-portal.css` | Modified | Re-tokenized with Sea Haven CSS vars |
|
||||
| `src/index.css` | Deleted | ~487 lines migrated to tokens + TSX shell |
|
||||
| `src/components/Sidebar.js` | Deleted | Replaced by `app-sidebar.tsx` |
|
||||
| `src/components/Topbar.js` | Deleted | Replaced by `app-topbar.tsx` |
|
||||
|
|
@ -59,7 +59,7 @@ Migration from legacy CSS (`index.css`, `#0c4f6f` palette) to Seahaven DS tokens
|
|||
| `src/app/(protected)/settings/dropdowns.tsx` | Modified | Semantic sidebar + active states |
|
||||
| `src/app/(protected)/settings/task-templates.tsx` | Modified | Semantic borders/text |
|
||||
| `src/components/common/settings-nav.tsx` | Modified | `text-primary`, `border-border` |
|
||||
| `src/components/common/calendar/calendar-utils.ts` | Modified | Bootstrap hex → Seahaven CSS vars |
|
||||
| `src/components/common/calendar/calendar-utils.ts` | Modified | Bootstrap hex → Sea Haven CSS vars |
|
||||
| `src/components/common/calendar/calendar-action-bar.tsx` | Modified | Semantic surface classes |
|
||||
| `src/components/common/calendar/event-calendar.tsx` | Modified | Semantic surface classes |
|
||||
| `src/components/common/signature-capture.tsx` | Modified | Canvas colors from CSS vars |
|
||||
|
|
@ -79,8 +79,8 @@ Migration from legacy CSS (`index.css`, `#0c4f6f` palette) to Seahaven DS tokens
|
|||
|
||||
- Primary color: `#0c4f6f` → `#1c75bc` (expected, documented)
|
||||
- Body font: Segoe UI 13px → DM Sans 14px
|
||||
- Sidebar: `#fbfbfb` → `#f6f8fb` with Seahaven active/hover states
|
||||
- Header: flat blue gradient → Seahaven multi-stop gradient
|
||||
- Sidebar: `#fbfbfb` → `#f6f8fb` with Sea Haven active/hover states
|
||||
- Header: flat blue gradient → Sea Haven multi-stop gradient
|
||||
|
||||
## Not migrated (intentional)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Feature Prioritization Matrix — SeaHaven
|
||||
# Feature Prioritization Matrix — Sea Haven
|
||||
|
||||
> Source of truth for legacy → `domain/` + `app/` migration order.
|
||||
> Machine-readable config: [`src/config/feature-priorities.ts`](../src/config/feature-priorities.ts).
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# SeaHaven UI - Complete Architecture Documentation
|
||||
# Sea Haven UI - Complete Architecture Documentation
|
||||
|
||||
> Modern React architecture with Redux Toolkit, React Query, and CSS Modules
|
||||
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
│ 5. BACKEND │
|
||||
│ │
|
||||
│ REST API │
|
||||
│ (SeaHaven Backend) │
|
||||
│ (Sea Haven Backend) │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
|
|
@ -539,6 +539,6 @@ const debouncedSearch = useDebounce(search, DEBOUNCE_SEARCH);
|
|||
|
||||
---
|
||||
|
||||
**Welcome to the modern SeaHaven UI! 🎊**
|
||||
**Welcome to the modern Sea Haven UI! 🎊**
|
||||
|
||||
_Last updated: 2026_
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<meta charset="utf-8" />
|
||||
<link rel="icon" href="/favicon.ico" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<meta name="theme-color" content="#000000" />
|
||||
<meta name="description" content="Seahaven - Officetrax" />
|
||||
<meta name="theme-color" content="#1c75bc" />
|
||||
<meta name="description" content="Sea Haven - Work Orders" />
|
||||
<link rel="apple-touch-icon" href="/logo192.png" />
|
||||
<link rel="manifest" href="/manifest.json" />
|
||||
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
referrerpolicy="no-referrer"
|
||||
/>
|
||||
|
||||
<title>Seahaven - Officetrax</title>
|
||||
<title>Sea Haven - Work Orders</title>
|
||||
</head>
|
||||
<body>
|
||||
<noscript>You need to enable JavaScript to run this app.</noscript>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Infrastructure & CI/CD — SeaHaven SHOC frontend
|
||||
# Infrastructure & CI/CD — Sea Haven SHOC frontend
|
||||
|
||||
AWS hosting for the Vite SPA, defined as an **AWS CDK** app local to this repo,
|
||||
deployed through the org's **reusable** GitHub Actions workflow.
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ export interface FrontendStackProps extends StackProps {
|
|||
}
|
||||
|
||||
/**
|
||||
* Static SPA hosting for the SeaHaven SHOC frontend:
|
||||
* Static SPA hosting for the Sea Haven SHOC frontend:
|
||||
* - private S3 bucket (no public access; CloudFront reads it via OAC)
|
||||
* - CloudFront distribution (HTTPS, SPA deep-link fallback)
|
||||
* - a GitHub Actions OIDC deploy role
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"name": "shoc-frontend-infra",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"description": "CDK app provisioning S3 + CloudFront hosting and the GitHub OIDC deploy role for the SeaHaven SHOC frontend.",
|
||||
"description": "CDK app provisioning S3 + CloudFront hosting and the GitHub OIDC deploy role for the Sea Haven SHOC frontend.",
|
||||
"bin": {
|
||||
"app": "bin/app.ts"
|
||||
},
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 2.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 4.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.4 KiB After Width: | Height: | Size: 5.3 KiB |
|
|
@ -1,10 +1,10 @@
|
|||
{
|
||||
"short_name": "React App",
|
||||
"name": "Create React App Sample",
|
||||
"short_name": "Work Orders",
|
||||
"name": "Sea Haven - Work Orders",
|
||||
"icons": [
|
||||
{
|
||||
"src": "favicon.ico",
|
||||
"sizes": "64x64 32x32 24x24 16x16",
|
||||
"sizes": "64x64 32x32 16x16",
|
||||
"type": "image/x-icon"
|
||||
},
|
||||
{
|
||||
|
|
@ -20,6 +20,6 @@
|
|||
],
|
||||
"start_url": ".",
|
||||
"display": "standalone",
|
||||
"theme_color": "#000000",
|
||||
"theme_color": "#1c75bc",
|
||||
"background_color": "#ffffff"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ export function BrandWordmark({ size = "default", className, ...props }: BrandWo
|
|||
size === "compact" ? "text-md" : "text-[16px]",
|
||||
)}
|
||||
>
|
||||
SEAHAVEN
|
||||
SEA HAVEN
|
||||
</div>
|
||||
<div
|
||||
className={cn(
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import type { StatusVariant } from "./status-badge";
|
||||
|
||||
/** Maps API / legacy status strings to Seahaven status variants. */
|
||||
/** Maps API / legacy status strings to Sea Haven status variants. */
|
||||
const STATUS_ALIASES: Record<string, StatusVariant> = {
|
||||
open: "incomplete",
|
||||
incomplete: "incomplete",
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/* Seahaven DS — self-hosted via @fontsource (matches theme.css stacks) */
|
||||
/* Sea Haven DS — self-hosted via @fontsource (matches theme.css stacks) */
|
||||
|
||||
@import "@fontsource/montserrat/600.css";
|
||||
@import "@fontsource/montserrat/700.css";
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@
|
|||
--shadow-lg: 0 10px 15px -3px rgba(22, 30, 56, 0.1), 0 4px 6px -4px rgba(22, 30, 56, 0.08);
|
||||
--shadow-brand-mark: 0 2px 6px -1px rgba(28, 117, 188, 0.45);
|
||||
|
||||
/* ── SHADCN BASE (Seahaven DS) ──────────────────────────────────── */
|
||||
/* ── SHADCN BASE (Sea Haven DS) ──────────────────────────────────── */
|
||||
--background: #ffffff;
|
||||
--foreground: #262262;
|
||||
--placeholder-foreground: color-mix(in srgb, var(--foreground) 50%, transparent);
|
||||
|
|
@ -79,7 +79,7 @@
|
|||
--chart-4: #7c3aed;
|
||||
--chart-5: #dc2626;
|
||||
|
||||
/* ── SIDEBAR (light surface — Seahaven DS) ──────────────────────── */
|
||||
/* ── SIDEBAR (light surface — Sea Haven DS) ──────────────────────── */
|
||||
--sidebar: #f6f8fb;
|
||||
--sidebar-bg: #f6f8fb;
|
||||
--sidebar-foreground: #262262;
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@
|
|||
"vite.config.ts",
|
||||
"vitest.config.ts",
|
||||
"config/api-url-contract.ts",
|
||||
"config/api-url-contract.test.ts"
|
||||
"config/api-url-contract.test.ts",
|
||||
"config/pwa-manifest.test.ts"
|
||||
]
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue