mirror of
https://github.com/Sea-Haven-Industries/shoc-frontend-new.git
synced 2026-09-30 09:13:11 +00:00
New react app for seahaven
0af9d871ab
Assign all files to the internal-dev team so every pull request needs an approving review from an internal-dev member, giving internal engineering oversight of changes. The org main-branch-protection ruleset enforces this via required code-owner review; the internal-dev team has write access, so it is an eligible code owner. |
||
|---|---|---|
| .cursor/rules | ||
| .github | ||
| .husky | ||
| config | ||
| docs | ||
| e2e/auth | ||
| public | ||
| src | ||
| .env | ||
| .env.development | ||
| .env.example | ||
| .env.production | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| commitlint.config.js | ||
| eslint.config.js | ||
| index.html | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.ts | ||
| vitest.config.ts | ||
SeaHaven Admin
Vite + React SPA for SeaHaven facility management (work orders, vendor portal, uplifts, and related admin features).
Requirements
- Node.js 20+
- npm 10+
Setup
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/apitoVITE_API_TARGET. - Production: use an absolute URL that ends with
/api(e.g.https://api.example.com/api). Absolute URLs without/apiwill produce broken API requests.
See .env.example and .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) |
Architecture
New code lives under src/domain/, src/app/, and src/api/ following the IrisLoan conventions documented in docs/ARCHITECTURE_PLAN.md.
CI
GitHub Actions workflow (.github/workflows/ci.yml) runs on push and pull requests:
npm run format:checknpm run lintnpm run buildnpm test
Local pre-commit hooks (Husky + lint-staged) run ESLint and Prettier on staged files.
Development proxy
During npm run dev, requests to /api are proxied to VITE_API_TARGET (see vite.config.ts).