How waleedahmd308/building-materials-explorer works
Building Materials Explorer is a Next.js storefront-style browser backed by a NestJS API over local JSON data. The principal flow is browsing or querying the product list, applying URL-backed search and filters, then opening a product detail page; the API filters and paginates results before returning them. Facets support filter choices, while site metadata and descriptive content form a separate misc endpoint. The tree also contains comparison pages and client state, although the README describes comparison as out of scope. Some UI-to-client wiring is unsampled, so those links rely on README-level evidence.
Main entry points: products.controller.ts Products routes · app.module.ts Application modules · page.tsx Product listing · api.ts API client
Components 17
Product explorer UI
- Product listing
frontend/src/app/page.tsx - Product detail
frontend/src/app/products/[id]/page.tsx - Comparison page
frontend/src/app/compare/page.tsx - Comparison state
frontend/src/lib/compareStore.ts - API client
frontend/src/lib/api.ts - URL query state
frontend/src/lib/searchParams.ts
NestJS API
- Products routes
backend/src/products/products.controller.ts - Query validation
backend/src/products/dto/products-query.dto.ts - Product operations
backend/src/products/products.service.ts - Misc route
backend/src/misc/misc.controller.ts - Application modules
backend/src/app.module.ts - Health route
backend/src/app.controller.ts
Product catalog
- Catalog queries
backend/src/products/products.repository.ts - Product JSON
backend/src/products/data/products.json
Site content
- Misc values
backend/src/misc/misc.service.ts - Site content data
backend/src/misc/misc.data.ts
Other components
- Visitor
Connections 17
- Visitor → Product listing: browses
README.md - Visitor → Product detail: opens product
README.md - Product listing → URL query state: reads URL state
README.md - Product listing → API client: requests products
README.md - Product detail → API client: requests product
README.md - API client → Products routes: calls API
README.md - Products routes → Product operations: delegates
backend/src/products/products.controller.ts - Products routes → Query validation: accepts query
backend/src/products/products.controller.ts - Product operations → Catalog queries: queries catalog
backend/src/products/products.service.ts - Catalog queries → Product JSON: reads records
backend/src/products/products.repository.ts - Visitor → Comparison page: opens comparison
- Comparison page → Comparison state: uses state
- Application modules → Products routes: registers routes
backend/src/app.module.ts - Application modules → Misc route: registers routes
backend/src/app.module.ts - Misc route → Misc values: delegates
backend/src/misc/misc.controller.ts - Misc values → Site content data: returns values
backend/src/misc/misc.service.ts - Application modules → Health route: registers controller
backend/src/app.module.ts