Used-car sales software for YS Heng. The platform combines a public vehicle catalogue, an internal operations portal, workflow controls, and a Docker-based deployment path.
| Area | Purpose | Technology |
|---|---|---|
| Public website | Vehicle browsing, bilingual content, vehicle details, and enquiries | Next.js, React, TypeScript |
| Operations portal | Inventory, repairs, loans, delivery, finance, leads, audit, HR, and administration | Vite, React, Ant Design |
| API | Business rules, authentication, role policies, uploads, reminders, and audit logging | .NET 10, EF Core, PostgreSQL |
| Infrastructure | Local Compose, VPS deployment, health checks, smoke tests, and backups | Docker Compose, Caddy, PowerShell, Bash |
flowchart LR
Customer[Customer] --> Front[Public website\nNext.js]
Staff[Staff] --> Back[Operations portal\nReact + Ant Design]
Front --> API[.NET 10 API]
Back --> API
API --> DB[(PostgreSQL)]
API --> Worker[Reminder worker]
API --> Storage[Database file storage]
Caddy[Caddy HTTPS ingress] --> Front
Caddy --> Back
Caddy --> API
For the detailed service map and deployment shape, see the architecture guide.
- Node.js compatible with the checked-in lockfile
- .NET SDK
10.0.100or a compatible feature roll-forward - Docker Desktop with the Linux engine, or PostgreSQL 17 for the clean local smoke runner
- Windows PowerShell for the included infrastructure scripts
npm install
npm run lint
npm run build
npm --workspace apps/frontoffice run test
npm --workspace apps/backoffice run test
dotnet test services\api\YSHeng.slnRun the complete local verification gate:
.\infra\verify-local.ps1The gate covers web checks, API tests, deployment contracts, environment validation, production builds, and the clean local smoke stack. Docker Compose runtime verification requires a responding Docker engine.
| Service | URL |
|---|---|
| Public website | http://localhost:3000 |
| Operations portal | http://localhost:3001 |
| API | http://localhost:5000 |
For local Docker usage, copy infra/compose.env.local.example to .env, then follow the deployment runbook.
- Architecture
- Implementation status
- API and role-policy reference
- Deployment runbook
- Requirements trace
- SEO and measurement notes
- Source requirements cross-check
This repository contains the current YS Heng MVP implementation and its deployment tooling. Business rules, public-data boundaries, role policies, upload limits, and deployment assumptions are documented and covered by focused tests or contract checks.
Production deployment is manual-dispatch and environment-approval gated. A successful CI run proves the verification jobs; production completion additionally requires the deployment job and HTTPS smoke checks to pass.
- Public routes are kept under
/api/public/*and expose only public vehicle and enquiry data. - Back-office routes use ASP.NET Identity authentication and role policies.
- Finance operations require the Finance policy.
- Vehicle photos are limited to 5 MB and documents to 10 MB.
- Production credentials belong in protected environment configuration, never in source control.
- PostgreSQL backups are part of the VPS operating routine because uploaded files are stored with the application data.
See the deployment runbook for environment setup, backups, restore procedures, and production verification.
The repository does not currently declare an open-source license. Add an explicit license or proprietary-use notice before distributing the code outside the project team.
